v1alpha.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
/// <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_v1alpha {
export interface Options extends GlobalOptions {
version: 'v1alpha';
}
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('v1alpha');
* ```
*/
export class Osconfig {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document
*/
export interface Schema$CVSSv3 {
/**
* This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.
*/
attackComplexity?: string | null;
/**
* This metric reflects the context by which vulnerability exploitation is possible.
*/
attackVector?: string | null;
/**
* This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
*/
availabilityImpact?: string | null;
/**
* The base score is a function of the base metric scores. https://www.first.org/cvss/specification-document#Base-Metrics
*/
baseScore?: number | null;
/**
* This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.
*/
confidentialityImpact?: string | null;
/**
* The Exploitability sub-score equation is derived from the Base Exploitability metrics. https://www.first.org/cvss/specification-document#2-1-Exploitability-Metrics
*/
exploitabilityScore?: number | null;
/**
* The Impact sub-score equation is derived from the Base Impact metrics.
*/
impactScore?: number | null;
/**
* This metric measures the impact to integrity of a successfully exploited vulnerability.
*/
integrityImpact?: string | null;
/**
* This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
*/
privilegesRequired?: string | null;
/**
* The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
*/
scope?: string | null;
/**
* This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
*/
userInteraction?: 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 {
}
/**
* 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;
}
/**
* This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time. A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM. You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy. For more information, see [View compliance](https://cloud.google.com/compute/docs/os-configuration-management/view-compliance).
*/
export interface Schema$InstanceOSPoliciesCompliance {
/**
* Output only. Detailed compliance state of the VM. This field is populated only when compliance state is `UNKNOWN`. It may contain one of the following values: * `no-compliance-data`: Compliance data is not available for this VM. * `no-agent-detected`: OS Config agent is not detected for this VM. * `config-not-supported-by-agent`: The version of the OS Config agent running on this VM does not support configuration management. * `inactive`: VM is not running. * `internal-service-errors`: There were internal service errors encountered while enforcing compliance. * `agent-errors`: OS config agent encountered errors while enforcing compliance.
*/
detailedState?: string | null;
/**
* Output only. The reason for the `detailed_state` of the VM (if any).
*/
detailedStateReason?: string | null;
/**
* Output only. The Compute Engine VM instance name.
*/
instance?: string | null;
/**
* Output only. Timestamp of the last compliance check for the VM.
*/
lastComplianceCheckTime?: string | null;
/**
* Output only. Unique identifier for the last compliance run. This id will be logged by the OS config agent during a compliance run and can be used for debugging and tracing purpose.
*/
lastComplianceRunId?: string | null;
/**
* Output only. The `InstanceOSPoliciesCompliance` API resource name. Format: `projects/{project_number\}/locations/{location\}/instanceOSPoliciesCompliances/{instance_id\}`
*/
name?: string | null;
/**
* Output only. Compliance data for each `OSPolicy` that is applied to the VM.
*/
osPolicyCompliances?: Schema$InstanceOSPoliciesComplianceOSPolicyCompliance[];
/**
* Output only. Compliance state of the VM.
*/
state?: string | null;
}
/**
* Compliance data for an OS policy
*/
export interface Schema$InstanceOSPoliciesComplianceOSPolicyCompliance {
/**
* Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment_id@revision_id\}`
*/
osPolicyAssignment?: string | null;
/**
* The OS policy id
*/
osPolicyId?: string | null;
/**
* Compliance data for each `OSPolicyResource` that is applied to the VM.
*/
osPolicyResourceCompliances?: Schema$OSPolicyResourceCompliance[];
/**
* Compliance state of the OS policy.
*/
state?: string | null;
}
/**
* This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected).
*/
export interface Schema$Inventory {
/**
* Output only. Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.
*/
items?: {
[key: string]: Schema$InventoryItem;
} | null;
/**
* Output only. The `Inventory` API resource name. Format: `projects/{project_number\}/locations/{location\}/instances/{instance_id\}/inventory`
*/
name?: string | null;
/**
* Output only. Base level operating system information for the VM.
*/
osInfo?: Schema$InventoryOsInfo;
/**
* Output only. Timestamp of the last reported inventory for the VM.
*/
updateTime?: string | null;
}
/**
* A single piece of inventory on a VM.
*/
export interface Schema$InventoryItem {
/**
* Software package available to be installed on the VM instance.
*/
availablePackage?: Schema$InventorySoftwarePackage;
/**
* When this inventory item was first detected.
*/
createTime?: string | null;
/**
* Identifier for this item, unique across items for this VM.
*/
id?: string | null;
/**
* Software package present on the VM instance.
*/
installedPackage?: Schema$InventorySoftwarePackage;
/**
* The origin of this inventory item.
*/
originType?: string | null;
/**
* The specific type of inventory, correlating to its specific details.
*/
type?: string | null;
/**
* When this inventory item was last modified.
*/
updateTime?: string | null;
}
/**
* Operating system information for the VM.
*/
export interface Schema$InventoryOsInfo {
/**
* The system architecture of the operating system.
*/
architecture?: string | null;
/**
* The VM hostname.
*/
hostname?: string | null;
/**
* The kernel release of the operating system.
*/
kernelRelease?: string | null;
/**
* The kernel version of the operating system.
*/
kernelVersion?: string | null;
/**
* The operating system long name. For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019 Datacenter'.
*/
longName?: string | null;
/**
* The current version of the OS Config agent running on the VM.
*/
osconfigAgentVersion?: string | null;
/**
* The operating system short name. For example, 'windows' or 'debian'.
*/
shortName?: string | null;
/**
* The version of the operating system.
*/
version?: string | null;
}
/**
* Software package information of the operating system.
*/
export interface Schema$InventorySoftwarePackage {
/**
* Details of an APT package. For details about the apt package manager, see https://wiki.debian.org/Apt.
*/
aptPackage?: Schema$InventoryVersionedPackage;
/**
* Details of a COS package.
*/
cosPackage?: Schema$InventoryVersionedPackage;
/**
* Details of a Googet package. For details about the googet package manager, see https://github.com/google/googet.
*/
googetPackage?: Schema$InventoryVersionedPackage;
/**
* Details of a Windows Quick Fix engineering package. See https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering for info in Windows Quick Fix Engineering.
*/
qfePackage?: Schema$InventoryWindowsQuickFixEngineeringPackage;
/**
* Details of a Windows Update package. See https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for information about Windows Update.
*/
wuaPackage?: Schema$InventoryWindowsUpdatePackage;
/**
* Yum package info. For details about the yum package manager, see https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum.
*/
yumPackage?: Schema$InventoryVersionedPackage;
/**
* Details of a Zypper package. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual.
*/
zypperPackage?: Schema$InventoryVersionedPackage;
/**
* Details of a Zypper patch. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual.
*/
zypperPatch?: Schema$InventoryZypperPatch;
}
/**
* Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.
*/
export interface Schema$InventoryVersionedPackage {
/**
* The system architecture this package is intended for.
*/
architecture?: string | null;
/**
* The name of the package.
*/
packageName?: string | null;
/**
* The version of the package.
*/
version?: string | null;
}
/**
* Information related to a Quick Fix Engineering package. Fields are taken from Windows QuickFixEngineering Interface and match the source names: https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering
*/
export interface Schema$InventoryWindowsQuickFixEngineeringPackage {
/**
* A short textual description of the QFE update.
*/
caption?: string | null;
/**
* A textual description of the QFE update.
*/
description?: string | null;
/**
* Unique identifier associated with a particular QFE update.
*/
hotFixId?: string | null;
/**
* Date that the QFE update was installed. Mapped from installed_on field.
*/
installTime?: string | null;
}
/**
* Details related to a Windows Update package. Field data and names are taken from Windows Update API IUpdate Interface: https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive fields like title, and description are localized based on the locale of the VM being updated.
*/
export interface Schema$InventoryWindowsUpdatePackage {
/**
* The categories that are associated with this update package.
*/
categories?: Schema$InventoryWindowsUpdatePackageWindowsUpdateCategory[];
/**
* The localized description of the update package.
*/
description?: string | null;
/**
* A collection of Microsoft Knowledge Base article IDs that are associated with the update package.
*/
kbArticleIds?: string[] | null;
/**
* The last published date of the update, in (UTC) date and time.
*/
lastDeploymentChangeTime?: string | null;
/**
* A collection of URLs that provide more information about the update package.
*/
moreInfoUrls?: string[] | null;
/**
* The revision number of this update package.
*/
revisionNumber?: number | null;
/**
* A hyperlink to the language-specific support information for the update.
*/
supportUrl?: string | null;
/**
* The localized title of the update package.
*/
title?: string | null;
/**
* Gets the identifier of an update package. Stays the same across revisions.
*/
updateId?: string | null;
}
/**
* Categories specified by the Windows Update.
*/
export interface Schema$InventoryWindowsUpdatePackageWindowsUpdateCategory {
/**
* The identifier of the windows update category.
*/
id?: string | null;
/**
* The name of the windows update category.
*/
name?: string | null;
}
/**
* Details related to a Zypper Patch.
*/
export interface Schema$InventoryZypperPatch {
/**
* The category of the patch.
*/
category?: string | null;
/**
* The name of the patch.
*/
patchName?: string | null;
/**
* The severity specified for this patch
*/
severity?: string | null;
/**
* Any summary information provided about this patch.
*/
summary?: string | null;
}
/**
* A response message for listing OS policies compliance data for all Compute Engine VMs in the given location.
*/
export interface Schema$ListInstanceOSPoliciesCompliancesResponse {
/**
* List of instance OS policies compliance objects.
*/
instanceOsPoliciesCompliances?: Schema$InstanceOSPoliciesCompliance[];
/**
* The pagination token to retrieve the next page of instance OS policies compliance objects.
*/
nextPageToken?: string | null;
}
/**
* A response message for listing inventory data for all VMs in a specified location.
*/
export interface Schema$ListInventoriesResponse {
/**
* List of inventory objects.
*/
inventories?: Schema$Inventory[];
/**
* The pagination token to retrieve the next page of inventory objects.
*/
nextPageToken?: string | null;
}
/**
* A response message for listing all revisions for a OS policy assignment.
*/
export interface Schema$ListOSPolicyAssignmentRevisionsResponse {
/**
* The pagination token to retrieve the next page of OS policy assignment revisions.
*/
nextPageToken?: string | null;
/**
* The OS policy assignment revisions
*/
osPolicyAssignments?: Schema$OSPolicyAssignment[];
}
/**
* A response message for listing all assignments under given parent.
*/
export interface Schema$ListOSPolicyAssignmentsResponse {
/**
* The pagination token to retrieve the next page of OS policy assignments.
*/
nextPageToken?: string | null;
/**
* The list of assignments
*/
osPolicyAssignments?: Schema$OSPolicyAssignment[];
}
/**
* A response message for listing vulnerability reports for all VM instances in the specified location.
*/
export interface Schema$ListVulnerabilityReportsResponse {
/**
* The pagination token to retrieve the next page of vulnerabilityReports object.
*/
nextPageToken?: string | null;
/**
* List of vulnerabilityReport objects.
*/
vulnerabilityReports?: Schema$VulnerabilityReport[];
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* An OS policy defines the desired state configuration for a VM.
*/
export interface Schema$OSPolicy {
/**
* This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be reported as compliant even if the policy has nothing to validate or enforce.
*/
allowNoResourceGroupMatch?: boolean | null;
/**
* Policy description. Length of the description is limited to 1024 characters.
*/
description?: string | null;
/**
* Required. The id of the OS policy 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 assignment.
*/
id?: string | null;
/**
* Required. Policy mode
*/
mode?: string | null;
/**
* Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled by the flag `allow_no_resource_group_match`
*/
resourceGroups?: Schema$OSPolicyResourceGroup[];
}
/**
* OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information, see [OS policy and OS policy assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies).
*/
export interface Schema$OSPolicyAssignment {
/**
* Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field.
*/
baseline?: boolean | null;
/**
* Output only. Indicates that this revision deletes the OS policy assignment.
*/
deleted?: boolean | null;
/**
* OS policy assignment description. Length of the description is limited to 1024 characters.
*/
description?: string | null;
/**
* Required. Filter to select VMs.
*/
instanceFilter?: Schema$OSPolicyAssignmentInstanceFilter;
/**
* Resource name. Format: `projects/{project_number\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment_id\}` This field is ignored when you create an OS policy assignment.
*/
name?: string | null;
/**
* Required. List of OS policies to be applied to the VMs.
*/
osPolicies?: Schema$OSPolicy[];
/**
* Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING
*/
reconciling?: boolean | null;
/**
* Output only. The timestamp that the revision was created.
*/
revisionCreateTime?: string | null;
/**
* Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment
*/
revisionId?: string | null;
/**
* Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted.
*/
rollout?: Schema$OSPolicyAssignmentRollout;
/**
* Output only. OS policy assignment rollout state
*/
rolloutState?: string | null;
/**
* Output only. Server generated unique id for the OS policy assignment resource.
*/
uid?: string | null;
}
/**
* Message to represent the filters to select VMs for an assignment
*/
export interface Schema$OSPolicyAssignmentInstanceFilter {
/**
* Target all VMs in the project. If true, no other criteria is permitted.
*/
all?: boolean | null;
/**
* List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM. This filter is applied last in the filtering chain and therefore a VM is guaranteed to be excluded if it satisfies one of the below label sets.
*/
exclusionLabels?: Schema$OSPolicyAssignmentLabelSet[];
/**
* List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM.
*/
inclusionLabels?: Schema$OSPolicyAssignmentLabelSet[];
/**
* A VM is included if it's OS short name matches with any of the values provided in this list.
*/
osShortNames?: string[] | null;
}
/**
* Message representing label set. * A label is a key value pair set for a VM. * A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: `env=prod` and `type=webserver` will only be applicable for those VMs with both labels present.
*/
export interface Schema$OSPolicyAssignmentLabelSet {
/**
* Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected.
*/
labels?: {
[key: string]: 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;
}
/**
* Message to configure the rollout at the zonal level for the OS policy assignment.
*/
export interface Schema$OSPolicyAssignmentRollout {
/**
* Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment.
*/
disruptionBudget?: Schema$FixedOrPercent;
/**
* Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the `disruption_budget` at least until this duration of time has passed after configuration changes are applied.
*/
minWaitDuration?: string | null;
}
/**
* The `OSFilter` is used to specify the OS filtering criteria for the resource group.
*/
export interface Schema$OSPolicyOSFilter {
/**
* This should match OS short name emitted by the OS inventory agent. An empty value matches any OS.
*/
osShortName?: string | null;
/**
* This value should match the version emitted by the OS inventory agent. Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following value for this field `7.*`
*/
osVersion?: string | null;
}
/**
* An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.
*/
export interface Schema$OSPolicyResource {
/**
* Exec resource
*/
exec?: Schema$OSPolicyResourceExecResource;
/**
* File resource
*/
file?: Schema$OSPolicyResourceFileResource;
/**
* Required. The id of the resource 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 OS policy.
*/
id?: string | null;
/**
* Package resource
*/
pkg?: Schema$OSPolicyResourcePackageResource;
/**
* Package repository resource
*/
repository?: Schema$OSPolicyResourceRepositoryResource;
}
/**
* Compliance data for an OS policy resource.
*/
export interface Schema$OSPolicyResourceCompliance {
/**
* Ordered list of configuration steps taken by the agent for the OS policy resource.
*/
configSteps?: Schema$OSPolicyResourceConfigStep[];
/**
* ExecResource specific output.
*/
execResourceOutput?: Schema$OSPolicyResourceComplianceExecResourceOutput;
/**
* The id of the OS policy resource.
*/
osPolicyResourceId?: string | null;
/**
* Compliance state of the OS policy resource.
*/
state?: string | null;
}
/**
* ExecResource specific output.
*/
export interface Schema$OSPolicyResourceComplianceExecResourceOutput {
/**
* Output from Enforcement phase output file (if run). Output size is limited to 100K bytes.
*/
enforcementOutput?: string | null;
}
/**
* Step performed by the OS Config agent for configuring an `OSPolicyResource` to its desired state.
*/
export interface Schema$OSPolicyResourceConfigStep {
/**
* Outcome of the configuration step.
*/
outcome?: string | null;
/**
* Configuration step type.
*/
type?: string | null;
}
/**
* A resource that allows executing scripts on the VM. The `ExecResource` has 2 stages: `validate` and `enforce` and both stages accept a script as an argument to execute. When the `ExecResource` is applied by the agent, it first executes the script in the `validate` stage. The `validate` stage can signal that the `ExecResource` is already in the desired state by returning an exit code of `100`. If the `ExecResource` is not in the desired state, it should return an exit code of `101`. Any other exit code returned by this stage is considered an error. If the `ExecResource` is not in the desired state based on the exit code from the `validate` stage, the agent proceeds to execute the script from the `enforce` stage. If the `ExecResource` is already in the desired state, the `enforce` stage will not be run. Similar to `validate` stage, the `enforce` stage should return an exit code of `100` to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of `100` was chosen over `0` (and `101` vs `1`) to have an explicit indicator of `in desired state`, `not in desired state` and errors. Because, for example, Powershell will always return an exit code of `0` unless an `exit` statement is provided in the script. So, for reasons of consistency and being explicit, exit codes `100` and `101` were chosen.
*/
export interface Schema$OSPolicyResourceExecResource {
/**
* What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce.
*/
enforce?: Schema$OSPolicyResourceExecResourceExec;
/**
* Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.
*/
validate?: Schema$OSPolicyResourceExecResourceExec;
}
/**
* A file or script to execute.
*/
export interface Schema$OSPolicyResourceExecResourceExec {
/**
* Optional arguments to pass to the source during execution.
*/
args?: string[] | null;
/**
* A remote or local file.
*/
file?: Schema$OSPolicyResourceFile;
/**
* Required. The script interpreter to use.
*/
interpreter?: string | null;
/**
* Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
*/
outputFilePath?: string | null;
/**
* An inline script. The size of the script is limited to 1024 characters.
*/
script?: string | null;
}
/**
* A remote or local file.
*/
export interface Schema$OSPolicyResourceFile {
/**
* Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be specified.
*/
allowInsecure?: boolean | null;
/**
* A Cloud Storage object.
*/
gcs?: Schema$OSPolicyResourceFileGcs;
/**
* A local path within the VM to use.
*/
localPath?: string | null;
/**
* A generic remote file.
*/
remote?: Schema$OSPolicyResourceFileRemote;
}
/**
* Specifies a file available as a Cloud Storage Object.
*/
export interface Schema$OSPolicyResourceFileGcs {
/**
* Required. Bucket of the Cloud Storage object.
*/
bucket?: string | null;
/**
* Generation number of the Cloud Storage object.
*/
generation?: string | null;
/**
* Required. Name of the Cloud Storage object.
*/
object?: string | null;
}
/**
* Specifies a file available via some URI.
*/
export interface Schema$OSPolicyResourceFileRemote {
/**
* SHA256 checksum of the remote file.
*/
sha256Checksum?: string | null;
/**
* Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol\}://{location\}`.
*/
uri?: string | null;
}
/**
* A resource that manages the state of a file.
*/
export interface Schema$OSPolicyResourceFileResource {
/**
* A a file with this content. The size of the content is limited to 1024 characters.
*/
content?: string | null;
/**
* A remote or local source.
*/
file?: Schema$OSPolicyResourceFile;
/**
* Required. The absolute path of the file within the VM.
*/
path?: string | 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;
/**
* Required. Desired state of the file.
*/
state?: string | null;
}
/**
* Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the `OSFilter` specified within the resource group.
*/
export interface Schema$OSPolicyResourceGroup {
/**
* Used to specify the OS filter for a resource group
*/
osFilter?: Schema$OSPolicyOSFilter;
/**
* Required. List of resources configured for this resource group. The resources are executed in the exact order specified here.
*/
resources?: Schema$OSPolicyResource[];
}
/**
* A resource that manages a system package.
*/
export interface Schema$OSPolicyResourcePackageResource {
/**
* A package managed by Apt.
*/
apt?: Schema$OSPolicyResourcePackageResourceAPT;
/**
* A deb package file.
*/
deb?: Schema$OSPolicyResourcePackageResourceDeb;
/**
* Required. The desired state the agent should maintain for this package.
*/
desiredState?: string | null;
/**
* A package managed by GooGet.
*/
googet?: Schema$OSPolicyResourcePackageResourceGooGet;
/**
* An MSI package.
*/
msi?: Schema$OSPolicyResourcePackageResourceMSI;
/**
* An rpm package file.
*/
rpm?: Schema$OSPolicyResourcePackageResourceRPM;
/**
* A package managed by YUM.
*/
yum?: Schema$OSPolicyResourcePackageResourceYUM;
/**
* A package managed by Zypper.
*/
zypper?: Schema$OSPolicyResourcePackageResourceZypper;
}
/**
* A package managed by APT. - install: `apt-get update && apt-get -y install [name]` - remove: `apt-get -y remove [name]`
*/
export interface Schema$OSPolicyResourcePackageResourceAPT {
/**
* Required. Package name.
*/
name?: string | null;
}
/**
* A deb package file. dpkg packages only support INSTALLED state.
*/
export interface Schema$OSPolicyResourcePackageResourceDeb {
/**
* Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb`
*/
pullDeps?: boolean | null;
/**
* Required. A deb package.
*/
source?: Schema$OSPolicyResourceFile;
}
/**
* A package managed by GooGet. - install: `googet -noconfirm install package` - remove: `googet -noconfirm remove package`
*/
export interface Schema$OSPolicyResourcePackageResourceGooGet {
/**
* Required. Package name.
*/
name?: string | null;
}
/**
* An MSI package. MSI packages only support INSTALLED state.
*/
export interface Schema$OSPolicyResourcePackageResourceMSI {
/**
* Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`.
*/
properties?: string[] | null;
/**
* Required. The MSI package.
*/
source?: Schema$OSPolicyResourceFile;
}
/**
* An RPM package file. RPM packages only support INSTALLED state.
*/
export interface Schema$OSPolicyResourcePackageResourceRPM {
/**
* Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y install package.rpm`
*/
pullDeps?: boolean | null;
/**
* Required. An rpm package.
*/
source?: Schema$OSPolicyResourceFile;
}
/**
* A package managed by YUM. - install: `yum -y install package` - remove: `yum -y remove package`
*/
export interface Schema$OSPolicyResourcePackageResourceYUM {
/**
* Required. Package name.
*/
name?: string | null;
}
/**
* A package managed by Zypper. - install: `zypper -y install package` - remove: `zypper -y rm package`
*/
export interface Schema$OSPolicyResourcePackageResourceZypper {
/**
* Required. Package name.
*/
name?: string | null;
}
/**
* A resource that manages a package repository.
*/
export interface Schema$OSPolicyResourceRepositoryResource {
/**
* An Apt Repository.
*/
apt?: Schema$OSPolicyResourceRepositoryResourceAptRepository;
/**
* A Goo Repository.
*/
goo?: Schema$OSPolicyResourceRepositoryResourceGooRepository;
/**
* A Yum Repository.
*/
yum?: Schema$OSPolicyResourceRepositoryResourceYumRepository;
/**
* A Zypper Repository.
*/
zypper?: Schema$OSPolicyResourceRepositoryResourceZypperRepository;
}
/**
* Represents a single apt package repository. These will be added to a repo file that will be managed at `/etc/apt/sources.list.d/google_osconfig.list`.
*/
export interface Schema$OSPolicyResourceRepositoryResourceAptRepository {
/**
* Required. Type of archive files in this repository.
*/
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`.
*/
gpgKey?: string | null;
/**
* Required. URI for this repository.
*/
uri?: string | null;
}
/**
* Represents a Goo package repository. These are added to a repo file that is managed at `C:/ProgramData/GooGet/repos/google_osconfig.repo`.
*/
export interface Schema$OSPolicyResourceRepositoryResourceGooRepository {
/**
* Required. The name of the repository.
*/
name?: string | null;
/**
* Required. The url of the repository.
*/
url?: string | null;
}
/**
* Represents a single yum package repository. These are added to a repo file that is managed at `/etc/yum.repos.d/google_osconfig.repo`.
*/
export interface Schema$OSPolicyResourceRepositoryResourceYumRepository {
/**
* 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 resource conflicts.
*/
id?: string | null;
}
/**
* Represents a single zypper package repository. These are added to a repo file that is managed at `/etc/zypp/repos.d/google_osconfig.repo`.
*/
export interface Schema$OSPolicyResourceRepositoryResourceZypperRepository {
/**
* 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 GuestPolicy conflicts.
*/
id?: string | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see [Vulnerability reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports).
*/
export interface Schema$VulnerabilityReport {
/**
* Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number\}/locations/{location\}/instances/{instance_id\}/vulnerabilityReport`
*/
name?: string | null;
/**
* Output only. The timestamp for when the last vulnerability report was generated for the VM.
*/
updateTime?: string | null;
/**
* Output only. List of vulnerabilities affecting the VM.
*/
vulnerabilities?: Schema$VulnerabilityReportVulnerability[];
}
/**
* A vulnerability affecting the VM instance.
*/
export interface Schema$VulnerabilityReportVulnerability {
/**
* Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. If there is no available fix, the field is empty. The `inventory_item` value specifies the latest `SoftwarePackage` available to the VM that fixes the vulnerability.
*/
availableInventoryItemIds?: string[] | null;
/**
* The timestamp for when the vulnerability was first detected.
*/
createTime?: string | null;
/**
* Contains metadata as per the upstream feed of the operating system and NVD.
*/
details?: Schema$VulnerabilityReportVulnerabilityDetails;
/**
* Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM. This field displays the inventory items affected by this vulnerability. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM inventory. For some distros, this field may be empty.
*/
installedInventoryItemIds?: string[] | null;
/**
* The timestamp for when the vulnerability was last modified.
*/
updateTime?: string | null;
}
/**
* Contains metadata information for the vulnerability. This information is collected from the upstream feed of the operating system.
*/
export interface Schema$VulnerabilityReportVulnerabilityDetails {
/**
* The CVE of the vulnerability. CVE cannot be empty and the combination of should be unique across vulnerabilities for a VM.
*/
cve?: string | null;
/**
* The CVSS V2 score of this vulnerability. CVSS V2 score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
*/
cvssV2Score?: number | null;
/**
* The full description of the CVSSv3 for this vulnerability from NVD.
*/
cvssV3?: Schema$CVSSv3;
/**
* The note or description describing the vulnerability from the distro.
*/
description?: string | null;
/**
* Corresponds to the references attached to the `VulnerabilityDetails`.
*/
references?: Schema$VulnerabilityReportVulnerabilityDetailsReference[];
/**
* Assigned severity/impact ranking from the distro.
*/
severity?: string | null;
}
/**
* A reference for this vulnerability.
*/
export interface Schema$VulnerabilityReportVulnerabilityDetailsReference {
/**
* The url of the reference.
*/
url?: string | null;
}
export class Resource$Projects {
context: APIRequestContext;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Locations {
context: APIRequestContext;
instanceOSPoliciesCompliances: Resource$Projects$Locations$Instanceospoliciescompliances;
instances: Resource$Projects$Locations$Instances;
osPolicyAssignments: Resource$Projects$Locations$Ospolicyassignments;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Locations$Instanceospoliciescompliances {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Get OS policies compliance data for the specified Compute Engine VM instance.
* @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('v1alpha');
*
* 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.locations.instanceOSPoliciesCompliances.get({
* // Required. API resource name for instance OS policies compliance resource. Format: `projects/{project\}/locations/{location\}/instanceOSPoliciesCompliances/{instance\}` For `{project\}`, either Compute Engine project-number or project-id can be provided. For `{instance\}`, either Compute Engine VM instance-id or instance-name can be provided.
* name: 'projects/my-project/locations/my-location/instanceOSPoliciesCompliances/my-instanceOSPoliciesCompliance',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "detailedState": "my_detailedState",
* // "detailedStateReason": "my_detailedStateReason",
* // "instance": "my_instance",
* // "lastComplianceCheckTime": "my_lastComplianceCheckTime",
* // "lastComplianceRunId": "my_lastComplianceRunId",
* // "name": "my_name",
* // "osPolicyCompliances": [],
* // "state": "my_state"
* // }
* }
*
* 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$Locations$Instanceospoliciescompliances$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Instanceospoliciescompliances$Get, options?: MethodOptions): GaxiosPromise<Schema$InstanceOSPoliciesCompliance>;
get(params: Params$Resource$Projects$Locations$Instanceospoliciescompliances$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Instanceospoliciescompliances$Get, options: MethodOptions | BodyResponseCallback<Schema$InstanceOSPoliciesCompliance>, callback: BodyResponseCallback<Schema$InstanceOSPoliciesCompliance>): void;
get(params: Params$Resource$Projects$Locations$Instanceospoliciescompliances$Get, callback: BodyResponseCallback<Schema$InstanceOSPoliciesCompliance>): void;
get(callback: BodyResponseCallback<Schema$InstanceOSPoliciesCompliance>): void;
/**
* List OS policies compliance data for all Compute Engine VM instances in the specified zone.
* @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('v1alpha');
*
* 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.locations.instanceOSPoliciesCompliances.list({
* // If provided, this field specifies the criteria that must be met by a `InstanceOSPoliciesCompliance` API resource to be included in the response.
* filter: 'placeholder-value',
* // The maximum number of results to return.
* pageSize: 'placeholder-value',
* // A pagination token returned from a previous call to `ListInstanceOSPoliciesCompliances` that indicates where this listing should continue from.
* pageToken: 'placeholder-value',
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}` For `{project\}`, either Compute Engine project-number or project-id can be provided.
* parent: 'projects/my-project/locations/my-location',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "instanceOsPoliciesCompliances": [],
* // "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$Locations$Instanceospoliciescompliances$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Instanceospoliciescompliances$List, options?: MethodOptions): GaxiosPromise<Schema$ListInstanceOSPoliciesCompliancesResponse>;
list(params: Params$Resource$Projects$Locations$Instanceospoliciescompliances$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Instanceospoliciescompliances$List, options: MethodOptions | BodyResponseCallback<Schema$ListInstanceOSPoliciesCompliancesResponse>, callback: BodyResponseCallback<Schema$ListInstanceOSPoliciesCompliancesResponse>): void;
list(params: Params$Resource$Projects$Locations$Instanceospoliciescompliances$List, callback: BodyResponseCallback<Schema$ListInstanceOSPoliciesCompliancesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListInstanceOSPoliciesCompliancesResponse>): void;
}
export interface Params$Resource$Projects$Locations$Instanceospoliciescompliances$Get extends StandardParameters {
/**
* Required. API resource name for instance OS policies compliance resource. Format: `projects/{project\}/locations/{location\}/instanceOSPoliciesCompliances/{instance\}` For `{project\}`, either Compute Engine project-number or project-id can be provided. For `{instance\}`, either Compute Engine VM instance-id or instance-name can be provided.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Instanceospoliciescompliances$List extends StandardParameters {
/**
* If provided, this field specifies the criteria that must be met by a `InstanceOSPoliciesCompliance` API resource to be included in the response.
*/
filter?: string;
/**
* The maximum number of results to return.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to `ListInstanceOSPoliciesCompliances` that indicates where this listing should continue from.
*/
pageToken?: string;
/**
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}` For `{project\}`, either Compute Engine project-number or project-id can be provided.
*/
parent?: string;
}
export class Resource$Projects$Locations$Instances {
context: APIRequestContext;
inventories: Resource$Projects$Locations$Instances$Inventories;
vulnerabilityReports: Resource$Projects$Locations$Instances$Vulnerabilityreports;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Locations$Instances$Inventories {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Get inventory data for the specified VM instance. If the VM has no associated inventory, the message `NOT_FOUND` is returned.
* @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('v1alpha');
*
* 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.locations.instances.inventories.get({
* // Required. API resource name for inventory resource. Format: `projects/{project\}/locations/{location\}/instances/{instance\}/inventory` For `{project\}`, either `project-number` or `project-id` can be provided. For `{instance\}`, either Compute Engine `instance-id` or `instance-name` can be provided.
* name: 'projects/my-project/locations/my-location/instances/my-instance/inventory',
* // Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
* view: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "items": {},
* // "name": "my_name",
* // "osInfo": {},
* // "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$Locations$Instances$Inventories$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Instances$Inventories$Get, options?: MethodOptions): GaxiosPromise<Schema$Inventory>;
get(params: Params$Resource$Projects$Locations$Instances$Inventories$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Instances$Inventories$Get, options: MethodOptions | BodyResponseCallback<Schema$Inventory>, callback: BodyResponseCallback<Schema$Inventory>): void;
get(params: Params$Resource$Projects$Locations$Instances$Inventories$Get, callback: BodyResponseCallback<Schema$Inventory>): void;
get(callback: BodyResponseCallback<Schema$Inventory>): void;
/**
* List inventory data for all VM instances in the specified zone.
* @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('v1alpha');
*
* 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.locations.instances.inventories.list({
* // If provided, this field specifies the criteria that must be met by a `Inventory` API resource to be included in the response.
* filter: 'placeholder-value',
* // The maximum number of results to return.
* pageSize: 'placeholder-value',
* // A pagination token returned from a previous call to `ListInventories` that indicates where this listing should continue from.
* pageToken: 'placeholder-value',
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/instances/{instance\}` For `{project\}`, either `project-number` or `project-id` can be provided. For `{instance\}`, only hyphen or dash character is supported to list inventories across VMs.
* parent: 'projects/my-project/locations/my-location/instances/my-instance',
* // Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
* view: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "inventories": [],
* // "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$Locations$Instances$Inventories$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Instances$Inventories$List, options?: MethodOptions): GaxiosPromise<Schema$ListInventoriesResponse>;
list(params: Params$Resource$Projects$Locations$Instances$Inventories$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Instances$Inventories$List, options: MethodOptions | BodyResponseCallback<Schema$ListInventoriesResponse>, callback: BodyResponseCallback<Schema$ListInventoriesResponse>): void;
list(params: Params$Resource$Projects$Locations$Instances$Inventories$List, callback: BodyResponseCallback<Schema$ListInventoriesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListInventoriesResponse>): void;
}
export interface Params$Resource$Projects$Locations$Instances$Inventories$Get extends StandardParameters {
/**
* Required. API resource name for inventory resource. Format: `projects/{project\}/locations/{location\}/instances/{instance\}/inventory` For `{project\}`, either `project-number` or `project-id` can be provided. For `{instance\}`, either Compute Engine `instance-id` or `instance-name` can be provided.
*/
name?: string;
/**
* Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
*/
view?: string;
}
export interface Params$Resource$Projects$Locations$Instances$Inventories$List extends StandardParameters {
/**
* If provided, this field specifies the criteria that must be met by a `Inventory` API resource to be included in the response.
*/
filter?: string;
/**
* The maximum number of results to return.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to `ListInventories` that indicates where this listing should continue from.
*/
pageToken?: string;
/**
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/instances/{instance\}` For `{project\}`, either `project-number` or `project-id` can be provided. For `{instance\}`, only hyphen or dash character is supported to list inventories across VMs.
*/
parent?: string;
/**
* Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
*/
view?: string;
}
export class Resource$Projects$Locations$Instances$Vulnerabilityreports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.
* @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('v1alpha');
*
* 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.locations.instances.vulnerabilityReports.get({
* // Required. API resource name for vulnerability resource. Format: `projects/{project\}/locations/{location\}/instances/{instance\}/vulnerabilityReport` For `{project\}`, either `project-number` or `project-id` can be provided. For `{instance\}`, either Compute Engine `instance-id` or `instance-name` can be provided.
* name: 'projects/my-project/locations/my-location/instances/my-instance/vulnerabilityReport',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "name": "my_name",
* // "updateTime": "my_updateTime",
* // "vulnerabilities": []
* // }
* }
*
* 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$Locations$Instances$Vulnerabilityreports$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$Get, options?: MethodOptions): GaxiosPromise<Schema$VulnerabilityReport>;
get(params: Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$Get, options: MethodOptions | BodyResponseCallback<Schema$VulnerabilityReport>, callback: BodyResponseCallback<Schema$VulnerabilityReport>): void;
get(params: Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$Get, callback: BodyResponseCallback<Schema$VulnerabilityReport>): void;
get(callback: BodyResponseCallback<Schema$VulnerabilityReport>): void;
/**
* List vulnerability reports for all VM instances in the specified zone.
* @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('v1alpha');
*
* 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.locations.instances.vulnerabilityReports.list({
* // If provided, this field specifies the criteria that must be met by a `vulnerabilityReport` API resource to be included in the response.
* filter: 'placeholder-value',
* // The maximum number of results to return.
* pageSize: 'placeholder-value',
* // A pagination token returned from a previous call to `ListVulnerabilityReports` that indicates where this listing should continue from.
* pageToken: 'placeholder-value',
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/instances/{instance\}` For `{project\}`, either `project-number` or `project-id` can be provided. For `{instance\}`, only `-` character is supported to list vulnerability reports across VMs.
* parent: 'projects/my-project/locations/my-location/instances/my-instance',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "vulnerabilityReports": []
* // }
* }
*
* 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$Locations$Instances$Vulnerabilityreports$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$List, options?: MethodOptions): GaxiosPromise<Schema$ListVulnerabilityReportsResponse>;
list(params: Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$List, options: MethodOptions | BodyResponseCallback<Schema$ListVulnerabilityReportsResponse>, callback: BodyResponseCallback<Schema$ListVulnerabilityReportsResponse>): void;
list(params: Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$List, callback: BodyResponseCallback<Schema$ListVulnerabilityReportsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListVulnerabilityReportsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$Get extends StandardParameters {
/**
* Required. API resource name for vulnerability resource. Format: `projects/{project\}/locations/{location\}/instances/{instance\}/vulnerabilityReport` For `{project\}`, either `project-number` or `project-id` can be provided. For `{instance\}`, either Compute Engine `instance-id` or `instance-name` can be provided.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Instances$Vulnerabilityreports$List extends StandardParameters {
/**
* If provided, this field specifies the criteria that must be met by a `vulnerabilityReport` API resource to be included in the response.
*/
filter?: string;
/**
* The maximum number of results to return.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to `ListVulnerabilityReports` that indicates where this listing should continue from.
*/
pageToken?: string;
/**
* Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/instances/{instance\}` For `{project\}`, either `project-number` or `project-id` can be provided. For `{instance\}`, only `-` character is supported to list vulnerability reports across VMs.
*/
parent?: string;
}
export class Resource$Projects$Locations$Ospolicyassignments {
context: APIRequestContext;
operations: Resource$Projects$Locations$Ospolicyassignments$Operations;
constructor(context: APIRequestContext);
/**
* Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
* @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('v1alpha');
*
* 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.locations.osPolicyAssignments.create({
* // Required. The logical name of the OS policy assignment 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.
* osPolicyAssignmentId: 'placeholder-value',
* // Required. The parent resource name in the form: projects/{project\}/locations/{location\}
* parent: 'projects/my-project/locations/my-location',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "baseline": false,
* // "deleted": false,
* // "description": "my_description",
* // "instanceFilter": {},
* // "name": "my_name",
* // "osPolicies": [],
* // "reconciling": false,
* // "revisionCreateTime": "my_revisionCreateTime",
* // "revisionId": "my_revisionId",
* // "rollout": {},
* // "rolloutState": "my_rolloutState",
* // "uid": "my_uid"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "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.
*/
create(params: Params$Resource$Projects$Locations$Ospolicyassignments$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Locations$Ospolicyassignments$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Locations$Ospolicyassignments$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Locations$Ospolicyassignments$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Locations$Ospolicyassignments$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
* @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('v1alpha');
*
* 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.locations.osPolicyAssignments.delete({
* // Required. The name of the OS policy assignment to be deleted
* name: 'projects/my-project/locations/my-location/osPolicyAssignments/my-osPolicyAssignment',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "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$Locations$Ospolicyassignments$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Locations$Ospolicyassignments$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Projects$Locations$Ospolicyassignments$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Locations$Ospolicyassignments$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Projects$Locations$Ospolicyassignments$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the `name` parameter.
* @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('v1alpha');
*
* 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.locations.osPolicyAssignments.get({
* // Required. The resource name of OS policy assignment. Format: `projects/{project\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment\}@{revisionId\}`
* name: 'projects/my-project/locations/my-location/osPolicyAssignments/my-osPolicyAssignment',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "baseline": false,
* // "deleted": false,
* // "description": "my_description",
* // "instanceFilter": {},
* // "name": "my_name",
* // "osPolicies": [],
* // "reconciling": false,
* // "revisionCreateTime": "my_revisionCreateTime",
* // "revisionId": "my_revisionId",
* // "rollout": {},
* // "rolloutState": "my_rolloutState",
* // "uid": "my_uid"
* // }
* }
*
* 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$Locations$Ospolicyassignments$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Ospolicyassignments$Get, options?: MethodOptions): GaxiosPromise<Schema$OSPolicyAssignment>;
get(params: Params$Resource$Projects$Locations$Ospolicyassignments$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Ospolicyassignments$Get, options: MethodOptions | BodyResponseCallback<Schema$OSPolicyAssignment>, callback: BodyResponseCallback<Schema$OSPolicyAssignment>): void;
get(params: Params$Resource$Projects$Locations$Ospolicyassignments$Get, callback: BodyResponseCallback<Schema$OSPolicyAssignment>): void;
get(callback: BodyResponseCallback<Schema$OSPolicyAssignment>): void;
/**
* List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.
* @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('v1alpha');
*
* 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.locations.osPolicyAssignments.list({
* // The maximum number of assignments to return.
* pageSize: 'placeholder-value',
* // A pagination token returned from a previous call to `ListOSPolicyAssignments` that indicates where this listing should continue from.
* pageToken: 'placeholder-value',
* // Required. The parent resource name.
* parent: 'projects/my-project/locations/my-location',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "osPolicyAssignments": []
* // }
* }
*
* 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$Locations$Ospolicyassignments$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Ospolicyassignments$List, options?: MethodOptions): GaxiosPromise<Schema$ListOSPolicyAssignmentsResponse>;
list(params: Params$Resource$Projects$Locations$Ospolicyassignments$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Ospolicyassignments$List, options: MethodOptions | BodyResponseCallback<Schema$ListOSPolicyAssignmentsResponse>, callback: BodyResponseCallback<Schema$ListOSPolicyAssignmentsResponse>): void;
list(params: Params$Resource$Projects$Locations$Ospolicyassignments$List, callback: BodyResponseCallback<Schema$ListOSPolicyAssignmentsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOSPolicyAssignmentsResponse>): void;
/**
* List the OS policy assignment revisions for a given OS policy assignment.
* @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('v1alpha');
*
* 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.locations.osPolicyAssignments.listRevisions({
* // Required. The name of the OS policy assignment to list revisions for.
* name: 'projects/my-project/locations/my-location/osPolicyAssignments/my-osPolicyAssignment',
* // The maximum number of revisions to return.
* pageSize: 'placeholder-value',
* // A pagination token returned from a previous call to `ListOSPolicyAssignmentRevisions` that indicates where this listing should continue from.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "osPolicyAssignments": []
* // }
* }
*
* 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.
*/
listRevisions(params: Params$Resource$Projects$Locations$Ospolicyassignments$Listrevisions, options: StreamMethodOptions): GaxiosPromise<Readable>;
listRevisions(params?: Params$Resource$Projects$Locations$Ospolicyassignments$Listrevisions, options?: MethodOptions): GaxiosPromise<Schema$ListOSPolicyAssignmentRevisionsResponse>;
listRevisions(params: Params$Resource$Projects$Locations$Ospolicyassignments$Listrevisions, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listRevisions(params: Params$Resource$Projects$Locations$Ospolicyassignments$Listrevisions, options: MethodOptions | BodyResponseCallback<Schema$ListOSPolicyAssignmentRevisionsResponse>, callback: BodyResponseCallback<Schema$ListOSPolicyAssignmentRevisionsResponse>): void;
listRevisions(params: Params$Resource$Projects$Locations$Ospolicyassignments$Listrevisions, callback: BodyResponseCallback<Schema$ListOSPolicyAssignmentRevisionsResponse>): void;
listRevisions(callback: BodyResponseCallback<Schema$ListOSPolicyAssignmentRevisionsResponse>): void;
/**
* Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1alpha/projects.locations.osPolicyAssignments.operations/cancel).
* @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('v1alpha');
*
* 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.locations.osPolicyAssignments.patch({
* // Resource name. Format: `projects/{project_number\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment_id\}` This field is ignored when you create an OS policy assignment.
* name: 'projects/my-project/locations/my-location/osPolicyAssignments/my-osPolicyAssignment',
* // Optional. Field mask that controls which fields of the assignment should be updated.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "baseline": false,
* // "deleted": false,
* // "description": "my_description",
* // "instanceFilter": {},
* // "name": "my_name",
* // "osPolicies": [],
* // "reconciling": false,
* // "revisionCreateTime": "my_revisionCreateTime",
* // "revisionId": "my_revisionId",
* // "rollout": {},
* // "rolloutState": "my_rolloutState",
* // "uid": "my_uid"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "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.
*/
patch(params: Params$Resource$Projects$Locations$Ospolicyassignments$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Locations$Ospolicyassignments$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Projects$Locations$Ospolicyassignments$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Locations$Ospolicyassignments$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Projects$Locations$Ospolicyassignments$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Ospolicyassignments$Create extends StandardParameters {
/**
* Required. The logical name of the OS policy assignment 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.
*/
osPolicyAssignmentId?: string;
/**
* Required. The parent resource name in the form: projects/{project\}/locations/{location\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$OSPolicyAssignment;
}
export interface Params$Resource$Projects$Locations$Ospolicyassignments$Delete extends StandardParameters {
/**
* Required. The name of the OS policy assignment to be deleted
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Ospolicyassignments$Get extends StandardParameters {
/**
* Required. The resource name of OS policy assignment. Format: `projects/{project\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment\}@{revisionId\}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Ospolicyassignments$List extends StandardParameters {
/**
* The maximum number of assignments to return.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to `ListOSPolicyAssignments` that indicates where this listing should continue from.
*/
pageToken?: string;
/**
* Required. The parent resource name.
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Ospolicyassignments$Listrevisions extends StandardParameters {
/**
* Required. The name of the OS policy assignment to list revisions for.
*/
name?: string;
/**
* The maximum number of revisions to return.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to `ListOSPolicyAssignmentRevisions` that indicates where this listing should continue from.
*/
pageToken?: string;
}
export interface Params$Resource$Projects$Locations$Ospolicyassignments$Patch extends StandardParameters {
/**
* Resource name. Format: `projects/{project_number\}/locations/{location\}/osPolicyAssignments/{os_policy_assignment_id\}` This field is ignored when you create an OS policy assignment.
*/
name?: string;
/**
* Optional. Field mask that controls which fields of the assignment should be updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$OSPolicyAssignment;
}
export class Resource$Projects$Locations$Ospolicyassignments$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
* @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('v1alpha');
*
* 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.locations.osPolicyAssignments.operations.cancel({
* // The name of the operation resource to be cancelled.
* name: 'projects/my-project/locations/my-location/osPolicyAssignments/my-osPolicyAssignment/operations/my-operation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* 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.
*/
cancel(params: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Cancel, options: StreamMethodOptions): GaxiosPromise<Readable>;
cancel(params?: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
cancel(params: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
cancel(params: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(params: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @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('v1alpha');
*
* 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.locations.osPolicyAssignments.operations.get({
* // The name of the operation resource.
* name: 'projects/my-project/locations/my-location/osPolicyAssignments/my-osPolicyAssignment/operations/my-operation',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "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.
*/
get(params: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Cancel extends StandardParameters {
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CancelOperationRequest;
}
export interface Params$Resource$Projects$Locations$Ospolicyassignments$Operations$Get extends StandardParameters {
/**
* The name of the operation resource.
*/
name?: string;
}
export {};
}