v1alpha1.d.ts
130 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace containeranalysis_v1alpha1 {
interface Options extends GlobalOptions {
version: 'v1alpha1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API
* access, quota, and reports. Required unless you provide an OAuth 2.0
* token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be
* any arbitrary string assigned to a user, but should not exceed 40
* characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Container Analysis API
*
* An implementation of the Grafeas API, which stores, and enables querying
* and retrieval of critical metadata about all of your software artifacts.
*
* @example
* const {google} = require('googleapis');
* const containeranalysis = google.containeranalysis('v1alpha1');
*
* @namespace containeranalysis
* @type {Function}
* @version v1alpha1
* @variation v1alpha1
* @param {object=} options Options for Containeranalysis
*/
class Containeranalysis {
context: APIRequestContext;
projects: Resource$Projects;
providers: Resource$Providers;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Artifact describes a build product.
*/
interface Schema$Artifact {
/**
* Hash or checksum value of a binary, or Docker Registry 2.0 digest of a
* container.
*/
checksum?: string;
/**
* Artifact ID, if any; for container images, this will be a URL by digest
* like gcr.io/projectID/imagename@sha256:123456
*/
id?: string;
/**
* Name of the artifact. This may be the path to a binary or jar file, or in
* the case of a container build, the name used to push the container image
* to Google Container Registry, as presented to `docker push`. This field
* is deprecated in favor of the plural `names` field; it continues to exist
* here to allow existing BuildProvenance serialized to json in
* google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes
* to deserialize back into proto.
*/
name?: string;
/**
* Related artifact names. This may be the path to a binary or jar file, or
* in the case of a container build, the name used to push the container
* image to Google Container Registry, as presented to `docker push`. Note
* that a single Artifact ID can have multiple names, for example if two
* tags are applied to one image.
*/
names?: string[];
}
/**
* Occurrence that represents a single "attestation". The
* authenticity of an Attestation can be verified using the attached
* signature. If the verifier trusts the public key of the signer, then
* verifying the signature is sufficient to establish trust. In this
* circumstance, the AttestationAuthority to which this Attestation is
* attached is primarily useful for look-up (how to find this Attestation if
* you already know the Authority and artifact to be verified) and intent
* (which authority was this attestation intended to sign for).
*/
interface Schema$Attestation {
pgpSignedAttestation?: Schema$PgpSignedAttestation;
}
/**
* Note kind that represents a logical attestation "role" or
* "authority". For example, an organization might have one
* `AttestationAuthority` for "QA" and one for "build".
* This Note is intended to act strictly as a grouping mechanism for the
* attached Occurrences (Attestations). This grouping mechanism also provides
* a security boundary, since IAM ACLs gate the ability for a principle to
* attach an Occurrence to a given Note. It also provides a single point of
* lookup to find all attached Attestation Occurrences, even if they don't
* all live in the same project.
*/
interface Schema$AttestationAuthority {
hint?: Schema$AttestationAuthorityHint;
}
/**
* This submessage provides human-readable hints about the purpose of the
* AttestationAuthority. Because the name of a Note acts as its resource
* reference, it is important to disambiguate the canonical name of the Note
* (which might be a UUID for security purposes) from "readable"
* names more suitable for debug output. Note that these hints should NOT be
* used to look up AttestationAuthorities in security sensitive contexts, such
* as when looking up Attestations to verify.
*/
interface Schema$AttestationAuthorityHint {
/**
* The human readable name of this Attestation Authority, for example
* "qa".
*/
humanReadableName?: string;
}
/**
* Specifies the audit configuration for a service. The configuration
* determines which permission types are logged, and what identities, if any,
* are exempted from logging. An AuditConfig must have one or more
* AuditLogConfigs. If there are AuditConfigs for both `allServices` and a
* specific service, the union of the two AuditConfigs is used for that
* service: the log_types specified in each AuditConfig are enabled, and the
* exempted_members in each AuditLogConfig are exempted. Example Policy with
* multiple AuditConfigs: { "audit_configs": [ {
* "service": "allServices" "audit_log_configs":
* [ { "log_type": "DATA_READ",
* "exempted_members": [ "user:foo@gmail.com" ] }, {
* "log_type": "DATA_WRITE", }, {
* "log_type": "ADMIN_READ", } ] },
* { "service": "fooservice.googleapis.com"
* "audit_log_configs": [ { "log_type":
* "DATA_READ", }, { "log_type":
* "DATA_WRITE", "exempted_members": [
* "user:bar@gmail.com" ] } ] }
* ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and
* ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging,
* and bar@gmail.com from DATA_WRITE logging.
*/
interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example,
* `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a
* special value that covers all services.
*/
service?: string;
}
/**
* Provides the configuration for logging a type of permissions. Example: {
* "audit_log_configs": [ { "log_type":
* "DATA_READ", "exempted_members": [
* "user:foo@gmail.com" ] }, {
* "log_type": "DATA_WRITE", } ] } This
* enables 'DATA_READ' and 'DATA_WRITE' logging, while
* exempting foo@gmail.com from DATA_READ logging.
*/
interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of
* permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[];
/**
* The log type that this config enables.
*/
logType?: string;
}
/**
* Basis describes the base image portion (Note) of the DockerImage
* relationship. Linked occurrences are derived from this or an equivalent
* image via: FROM <Basis.resource_url> Or an equivalent reference,
* e.g. a tag of the resource_url.
*/
interface Schema$Basis {
/**
* The fingerprint of the base image.
*/
fingerprint?: Schema$Fingerprint;
/**
* The resource_url for the resource representing the basis of associated
* occurrence images.
*/
resourceUrl?: string;
}
/**
* Associates `members` with a `role`.
*/
interface Schema$Binding {
/**
* The condition that is associated with this binding. NOTE: an unsatisfied
* condition will not allow user access via current binding. Different
* bindings, including their conditions, are examined independently.
*/
condition?: Schema$Expr;
/**
* Specifies the identities requesting access for a Cloud Platform resource.
* `members` can have the following values: * `allUsers`: A special
* identifier that represents anyone who is on the internet; with or
* without a Google account. * `allAuthenticatedUsers`: A special
* identifier that represents anyone who is authenticated with a Google
* account or a service account. * `user:{emailid}`: An email address that
* represents a specific Google account. For example, `alice@gmail.com` .
* * `serviceAccount:{emailid}`: An email address that represents a service
* account. For example, `my-other-app@appspot.gserviceaccount.com`. *
* `group:{emailid}`: An email address that represents a Google group. For
* example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
* (primary) that represents all the users of that domain. For example,
* `google.com` or `example.com`.
*/
members?: string[];
/**
* Role that is assigned to `members`. For example, `roles/viewer`,
* `roles/editor`, or `roles/owner`.
*/
role?: string;
}
/**
* Message encapsulating build provenance details.
*/
interface Schema$BuildDetails {
/**
* The actual provenance
*/
provenance?: Schema$BuildProvenance;
/**
* Serialized JSON representation of the provenance, used in generating the
* `BuildSignature` in the corresponding Result. After verifying the
* signature, `provenance_bytes` can be unmarshalled and compared to the
* provenance to confirm that it is unchanged. A base64-encoded string
* representation of the provenance bytes is used for the signature in order
* to interoperate with openssl which expects this format for signature
* verification. The serialized form is captured both to avoid ambiguity in
* how the provenance is marshalled to json as well to prevent
* incompatibilities with future changes.
*/
provenanceBytes?: string;
}
/**
* Provenance of a build. Contains all information needed to verify the full
* details about the build from source to completion.
*/
interface Schema$BuildProvenance {
/**
* Version string of the builder at the time this build was executed.
*/
builderVersion?: string;
/**
* Special options applied to this build. This is a catch-all field where
* build providers can enter any desired additional details.
*/
buildOptions?: {
[key: string]: string;
};
/**
* Output of the build.
*/
builtArtifacts?: Schema$Artifact[];
/**
* Commands requested by the build.
*/
commands?: Schema$Command[];
/**
* Time at which the build was created.
*/
createTime?: string;
/**
* E-mail address of the user who initiated this build. Note that this was
* the user's e-mail address at the time the build was initiated; this
* address may not represent the same end-user for all time.
*/
creator?: string;
/**
* Time at which execution of the build was finished.
*/
finishTime?: string;
/**
* Unique identifier of the build.
*/
id?: string;
/**
* Google Cloud Storage bucket where logs were written.
*/
logsBucket?: string;
/**
* ID of the project.
*/
projectId?: string;
/**
* Details of the Source input to the build.
*/
sourceProvenance?: Schema$Source;
/**
* Time at which execution of the build was started.
*/
startTime?: string;
/**
* Trigger identifier if the build was triggered automatically; empty if
* not.
*/
triggerId?: string;
}
/**
* Message encapsulating the signature of the verified build.
*/
interface Schema$BuildSignature {
/**
* An Id for the key used to sign. This could be either an Id for the key
* stored in `public_key` (such as the Id or fingerprint for a PGP key, or
* the CN for a cert), or a reference to an external key (such as a
* reference to a key in Cloud Key Management Service).
*/
keyId?: string;
/**
* The type of the key, either stored in `public_key` or referenced in
* `key_id`
*/
keyType?: string;
/**
* Public key of the builder which can be used to verify that the related
* findings are valid and unchanged. If `key_type` is empty, this defaults
* to PEM encoded public keys. This field may be empty if `key_id`
* references an external key. For Cloud Build based signatures, this is a
* PEM encoded public key. To verify the Cloud Build signature, place the
* contents of this field into a file (public.pem). The signature field is
* base64-decoded into its binary representation in signature.bin, and the
* provenance bytes from `BuildDetails` are base64-decoded into a binary
* representation in signed.bin. OpenSSL can then verify the signature:
* `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
*/
publicKey?: string;
/**
* Signature of the related `BuildProvenance`, encoded in a base64 string.
*/
signature?: string;
}
/**
* Note holding the version of the provider's builder and the signature of
* the provenance message in linked BuildDetails.
*/
interface Schema$BuildType {
/**
* Version of the builder which produced this Note.
*/
builderVersion?: string;
/**
* Signature of the build in Occurrences pointing to the Note containing
* this `BuilderDetails`.
*/
signature?: Schema$BuildSignature;
}
/**
* Command describes a step performed as part of the build pipeline.
*/
interface Schema$Command {
/**
* Command-line arguments used when executing this Command.
*/
args?: string[];
/**
* Working directory (relative to project source root) used when running
* this Command.
*/
dir?: string;
/**
* Environment variables set before running this Command.
*/
env?: string[];
/**
* Optional unique identifier for this Command, used in wait_for to
* reference this Command as a dependency.
*/
id?: string;
/**
* Name of the command, as presented on the command line, or if the command
* is packaged as a Docker container, as presented to `docker pull`.
*/
name?: string;
/**
* The ID(s) of the Command(s) that this Command depends on.
*/
waitFor?: string[];
}
/**
* Request for creating an operation
*/
interface Schema$CreateOperationRequest {
/**
* The operation to create.
*/
operation?: Schema$Operation;
/**
* The ID to use for this operation.
*/
operationId?: string;
}
/**
* An artifact that can be deployed in some runtime.
*/
interface Schema$Deployable {
/**
* Resource URI for the artifact being deployed.
*/
resourceUri?: string[];
}
/**
* The period during which some deployable was active in a runtime.
*/
interface Schema$Deployment {
/**
* Address of the runtime element hosting this deployment.
*/
address?: string;
/**
* Configuration used to create this deployment.
*/
config?: string;
/**
* Beginning of the lifetime of this deployment.
*/
deployTime?: string;
/**
* Platform hosting this deployment.
*/
platform?: string;
/**
* Output only. Resource URI for the artifact being deployed taken from the
* deployable field with the same name.
*/
resourceUri?: string[];
/**
* End of the lifetime of this deployment.
*/
undeployTime?: string;
/**
* Identity of the user that triggered this deployment.
*/
userEmail?: string;
}
/**
* Derived describes the derived image portion (Occurrence) of the DockerImage
* relationship. This image would be produced from a Dockerfile with FROM
* <DockerImage.Basis in attached Note>.
*/
interface Schema$Derived {
/**
* Output only. This contains the base image URL for the derived image
* occurrence.
*/
baseResourceUrl?: string;
/**
* Output only. The number of layers by which this image differs from the
* associated image basis.
*/
distance?: number;
/**
* The fingerprint of the derived image.
*/
fingerprint?: Schema$Fingerprint;
/**
* This contains layer-specific metadata, if populated it has length
* "distance" and is ordered with [distance] being the layer
* immediately following the base image and [1] being the final layer.
*/
layerInfo?: Schema$Layer[];
}
/**
* Identifies all occurrences of this vulnerability in the package for a
* specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8
* for versions 2.1 - 2.2
*/
interface Schema$Detail {
/**
* The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
* which the vulnerability manifests. Examples include distro or storage
* location for vulnerable jar. This field can be used as a filter in list
* requests.
*/
cpeUri?: string;
/**
* A vendor-specific description of this note.
*/
description?: string;
/**
* The fix for this specific package version.
*/
fixedLocation?: Schema$VulnerabilityLocation;
/**
* Whether this Detail is obsolete. Occurrences are expected not to point to
* obsolete details.
*/
isObsolete?: boolean;
/**
* The max version of the package in which the vulnerability exists. This
* field can be used as a filter in list requests.
*/
maxAffectedVersion?: Schema$Version;
/**
* The min version of the package in which the vulnerability exists.
*/
minAffectedVersion?: Schema$Version;
/**
* The name of the package where the vulnerability was found. This field can
* be used as a filter in list requests.
*/
package?: string;
/**
* The type of package; whether native or non native(ruby gems, node.js
* packages etc)
*/
packageType?: string;
/**
* The severity (eg: distro assigned severity) for this vulnerability.
*/
severityName?: string;
}
/**
* Provides information about the scan status of a discovered resource.
*/
interface Schema$Discovered {
/**
* The status of discovery for the resource.
*/
analysisStatus?: string;
/**
* When an error is encountered this will contain a LocalizedMessage under
* details to show to the user. The LocalizedMessage output only and
* populated by the API.
*/
analysisStatusError?: Schema$Status;
/**
* Whether the resource is continuously analyzed.
*/
continuousAnalysis?: string;
/**
* Output only. An operation that indicates the status of the current scan.
* This field is deprecated, do not use.
*/
operation?: Schema$Operation;
}
/**
* A note that indicates a type of analysis a provider would perform. This
* note exists in a provider's project. A `Discovery` occurrence is
* created in a consumer's project at the start of analysis. The
* occurrence's operation will indicate the status of the analysis.
* Absence of an occurrence linked to this note for a resource indicates that
* analysis hasn't started.
*/
interface Schema$Discovery {
/**
* The kind of analysis that is handled by this discovery.
*/
analysisKind?: string;
}
/**
* This represents a particular channel of distribution for a given package.
* e.g. Debian's jessie-backports dpkg mirror
*/
interface Schema$Distribution {
/**
* The CPU architecture for which packages in this distribution channel were
* built
*/
architecture?: string;
/**
* The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
* denoting the package manager version distributing a package.
*/
cpeUri?: string;
/**
* The distribution channel-specific description of this package.
*/
description?: string;
/**
* The latest available version of this package in this distribution
* channel.
*/
latestVersion?: Schema$Version;
/**
* A freeform string denoting the maintainer of this package.
*/
maintainer?: string;
/**
* The distribution channel-specific homepage for this package.
*/
url?: string;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated
* empty messages in your APIs. A typical example is to use it as the request
* or the response type of an API method. For instance: service Foo { rpc
* Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
* representation for `Empty` is empty JSON object `{}`.
*/
interface Schema$Empty {
}
/**
* Represents an expression text. Example: title: "User account
* presence" description: "Determines whether the request has a
* user account" expression: "size(request.user) > 0"
*/
interface Schema$Expr {
/**
* An optional description of the expression. This is a longer text which
* describes the expression, e.g. when hovered over it in a UI.
*/
description?: string;
/**
* Textual representation of an expression in Common Expression Language
* syntax. The application context of the containing message determines
* which well-known feature set of CEL is supported.
*/
expression?: string;
/**
* An optional string indicating the location of the expression for error
* reporting, e.g. a file name and a position in the file.
*/
location?: string;
/**
* An optional title for the expression, i.e. a short string describing its
* purpose. This can be used e.g. in UIs which allow to enter the
* expression.
*/
title?: string;
}
/**
* Container message for hashes of byte content of files, used in Source
* messages to verify integrity of source input to the build.
*/
interface Schema$FileHashes {
/**
* Collection of file hashes.
*/
fileHash?: Schema$Hash[];
}
/**
* A set of properties that uniquely identify a given Docker image.
*/
interface Schema$Fingerprint {
/**
* The layer-id of the final layer in the Docker image's v1
* representation. This field can be used as a filter in list requests.
*/
v1Name?: string;
/**
* The ordered list of v2 blobs that represent a given image.
*/
v2Blob?: string[];
/**
* Output only. The name of the image's v2 blobs computed via: [bottom]
* := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
* Only the name of the final blob is kept. This field can be used as a
* filter in list requests.
*/
v2Name?: string;
}
/**
* Request message for `GetIamPolicy` method.
*/
interface Schema$GetIamPolicyRequest {
}
/**
* A summary of how many vulnz occurrences there are per severity type. counts
* by groups, or if we should have different summary messages like this.
*/
interface Schema$GetVulnzOccurrencesSummaryResponse {
/**
* A map of how many occurrences were found for each severity.
*/
counts?: Schema$SeverityCount[];
}
/**
* An alias to a repo revision.
*/
interface Schema$GoogleDevtoolsContaineranalysisV1alpha1AliasContext {
/**
* The alias kind.
*/
kind?: string;
/**
* The alias name.
*/
name?: string;
}
/**
* A CloudRepoSourceContext denotes a particular revision in a Google Cloud
* Source Repo.
*/
interface Schema$GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContext {
/**
* An alias, which may be a branch or tag.
*/
aliasContext?: Schema$GoogleDevtoolsContaineranalysisV1alpha1AliasContext;
/**
* The ID of the repo.
*/
repoId?: Schema$GoogleDevtoolsContaineranalysisV1alpha1RepoId;
/**
* A revision ID.
*/
revisionId?: string;
}
/**
* A SourceContext referring to a Gerrit project.
*/
interface Schema$GoogleDevtoolsContaineranalysisV1alpha1GerritSourceContext {
/**
* An alias, which may be a branch or tag.
*/
aliasContext?: Schema$GoogleDevtoolsContaineranalysisV1alpha1AliasContext;
/**
* The full project name within the host. Projects may be nested, so
* "project/subproject" is a valid project name. The "repo
* name" is the hostURI/project.
*/
gerritProject?: string;
/**
* The URI of a running Gerrit instance.
*/
hostUri?: string;
/**
* A revision (commit) ID.
*/
revisionId?: string;
}
/**
* A GitSourceContext denotes a particular revision in a third party Git
* repository (e.g., GitHub).
*/
interface Schema$GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext {
/**
* Required. Git commit hash.
*/
revisionId?: string;
/**
* Git repository URL.
*/
url?: string;
}
/**
* Metadata for all operations used and required for all operations that
* created by Container Analysis Providers
*/
interface Schema$GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata {
/**
* Output only. The time this operation was created.
*/
createTime?: string;
/**
* Output only. The time that this operation was marked completed or failed.
*/
endTime?: string;
}
/**
* Selects a repo using a Google Cloud Platform project ID (e.g.,
* winged-cargo-31) and a repo name within that project.
*/
interface Schema$GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoId {
/**
* The ID of the project.
*/
projectId?: string;
/**
* The name of the repo. Leave empty for the default repo.
*/
repoName?: string;
}
/**
* A unique identifier for a Cloud Repo.
*/
interface Schema$GoogleDevtoolsContaineranalysisV1alpha1RepoId {
/**
* A combination of a project ID and a repo name.
*/
projectRepoId?: Schema$GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoId;
/**
* A server-assigned, globally unique identifier.
*/
uid?: string;
}
/**
* A SourceContext is a reference to a tree of files. A SourceContext together
* with a path point to a unique revision of a single file or directory.
*/
interface Schema$GoogleDevtoolsContaineranalysisV1alpha1SourceContext {
/**
* A SourceContext referring to a revision in a Google Cloud Source Repo.
*/
cloudRepo?: Schema$GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContext;
/**
* A SourceContext referring to a Gerrit project.
*/
gerrit?: Schema$GoogleDevtoolsContaineranalysisV1alpha1GerritSourceContext;
/**
* A SourceContext referring to any third party Git repo (e.g., GitHub).
*/
git?: Schema$GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext;
/**
* Labels with user defined metadata.
*/
labels?: {
[key: string]: string;
};
}
/**
* Container message for hash values.
*/
interface Schema$Hash {
/**
* The type of hash that was performed.
*/
type?: string;
/**
* The hash value.
*/
value?: string;
}
/**
* This represents how a particular software package may be installed on a
* system.
*/
interface Schema$Installation {
/**
* All of the places within the filesystem versions of this package have
* been found.
*/
location?: Schema$Location[];
/**
* Output only. The name of the installed package.
*/
name?: string;
}
/**
* Layer holds metadata specific to a layer of a Docker image.
*/
interface Schema$Layer {
/**
* The recovered arguments to the Dockerfile directive.
*/
arguments?: string;
/**
* The recovered Dockerfile directive used to construct this layer.
*/
directive?: string;
}
/**
* Response including listed occurrences for a note.
*/
interface Schema$ListNoteOccurrencesResponse {
/**
* Token to receive the next page of notes.
*/
nextPageToken?: string;
/**
* The occurrences attached to the specified note.
*/
occurrences?: Schema$Occurrence[];
}
/**
* Response including listed notes.
*/
interface Schema$ListNotesResponse {
/**
* The next pagination token in the list response. It should be used as
* page_token for the following request. An empty value means no more
* result.
*/
nextPageToken?: string;
/**
* The occurrences requested
*/
notes?: Schema$Note[];
}
/**
* Response including listed active occurrences.
*/
interface Schema$ListOccurrencesResponse {
/**
* The next pagination token in the list response. It should be used as
* `page_token` for the following request. An empty value means no more
* results.
*/
nextPageToken?: string;
/**
* The occurrences requested.
*/
occurrences?: Schema$Occurrence[];
}
/**
* A list of scan configs for the project.
*/
interface Schema$ListScanConfigsResponse {
/**
* A page token to pass in order to get more scan configs.
*/
nextPageToken?: string;
/**
* The set of scan configs.
*/
scanConfigs?: Schema$ScanConfig[];
}
/**
* An occurrence of a particular package installation found within a
* system's filesystem. e.g. glibc was found in /var/lib/dpkg/status
*/
interface Schema$Location {
/**
* The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
* denoting the package manager version distributing a package.
*/
cpeUri?: string;
/**
* The path from which we gathered that this package/version is installed.
*/
path?: string;
/**
* The version installed at this location.
*/
version?: Schema$Version;
}
/**
* Provides a detailed description of a `Note`.
*/
interface Schema$Note {
/**
* A note describing an attestation role.
*/
attestationAuthority?: Schema$AttestationAuthority;
/**
* A note describing a base image.
*/
baseImage?: Schema$Basis;
/**
* Build provenance type for a verifiable build.
*/
buildType?: Schema$BuildType;
/**
* Output only. The time this note was created. This field can be used as a
* filter in list requests.
*/
createTime?: string;
/**
* A note describing something that can be deployed.
*/
deployable?: Schema$Deployable;
/**
* A note describing a provider/analysis type.
*/
discovery?: Schema$Discovery;
/**
* Time of expiration for this note, null if note does not expire.
*/
expirationTime?: string;
/**
* Output only. This explicitly denotes which kind of note is specified.
* This field can be used as a filter in list requests.
*/
kind?: string;
/**
* A detailed description of this `Note`.
*/
longDescription?: string;
/**
* The name of the note in the form
* "providers/{provider_id}/notes/{NOTE_ID}"
*/
name?: string;
/**
* A note describing a package hosted by various package managers.
*/
package?: Schema$Package;
/**
* URLs associated with this note
*/
relatedUrl?: Schema$RelatedUrl[];
/**
* A one sentence description of this `Note`.
*/
shortDescription?: string;
/**
* Output only. The time this note was last updated. This field can be used
* as a filter in list requests.
*/
updateTime?: string;
/**
* A package vulnerability type of note.
*/
vulnerabilityType?: Schema$VulnerabilityType;
}
/**
* `Occurrence` includes information about analysis occurrences for an image.
*/
interface Schema$Occurrence {
/**
* Describes an attestation of an artifact.
*/
attestation?: Schema$Attestation;
/**
* Build details for a verifiable build.
*/
buildDetails?: Schema$BuildDetails;
/**
* Output only. The time this `Occurrence` was created.
*/
createTime?: string;
/**
* Describes the deployment of an artifact on a runtime.
*/
deployment?: Schema$Deployment;
/**
* Describes how this resource derives from the basis in the associated
* note.
*/
derivedImage?: Schema$Derived;
/**
* Describes the initial scan status for this resource.
*/
discovered?: Schema$Discovered;
/**
* Describes the installation of a package on the linked resource.
*/
installation?: Schema$Installation;
/**
* Output only. This explicitly denotes which of the `Occurrence` details
* are specified. This field can be used as a filter in list requests.
*/
kind?: string;
/**
* Output only. The name of the `Occurrence` in the form
* "projects/{project_id}/occurrences/{OCCURRENCE_ID}"
*/
name?: string;
/**
* An analysis note associated with this image, in the form
* "providers/{provider_id}/notes/{NOTE_ID}" This field can be
* used as a filter in list requests.
*/
noteName?: string;
/**
* A description of actions that can be taken to remedy the `Note`
*/
remediation?: string;
/**
* The resource for which the `Occurrence` applies.
*/
resource?: Schema$Resource;
/**
* The unique URL of the image or the container for which the `Occurrence`
* applies. For example, https://gcr.io/project/image@sha256:foo This field
* can be used as a filter in list requests.
*/
resourceUrl?: string;
/**
* Output only. The time this `Occurrence` was last updated.
*/
updateTime?: string;
/**
* Details of a security vulnerability note.
*/
vulnerabilityDetails?: Schema$VulnerabilityDetails;
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
};
/**
* The server-assigned name, which is only unique within the same service
* that originally returns it. If you use the default HTTP mapping, the
* `name` should have the format of `operations/some/unique/name`.
*/
name?: string;
/**
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
};
}
/**
* This represents a particular package that is distributed over various
* channels. e.g. glibc (aka libc6) is distributed by many, at various
* versions.
*/
interface Schema$Package {
/**
* The various channels by which a package is distributed.
*/
distribution?: Schema$Distribution[];
/**
* The name of the package.
*/
name?: string;
}
/**
* This message wraps a location affected by a vulnerability and its
* associated fix (if one is available).
*/
interface Schema$PackageIssue {
/**
* The location of the vulnerability.
*/
affectedLocation?: Schema$VulnerabilityLocation;
/**
* The location of the available fix for vulnerability.
*/
fixedLocation?: Schema$VulnerabilityLocation;
severityName?: string;
}
/**
* An attestation wrapper with a PGP-compatible signature. This message only
* supports `ATTACHED` signatures, where the payload that is signed is
* included alongside the signature itself in the same file.
*/
interface Schema$PgpSignedAttestation {
/**
* Type (for example schema) of the attestation payload that was signed. The
* verifier must ensure that the provided type is one that the verifier
* supports, and that the attestation payload is a valid instantiation of
* that type (for example by validating a JSON schema).
*/
contentType?: string;
/**
* The cryptographic fingerprint of the key used to generate the signature,
* as output by, e.g. `gpg --list-keys`. This should be the version 4, full
* 160-bit fingerprint, expressed as a 40 character hexadecimal string. See
* https://tools.ietf.org/html/rfc4880#section-12.2 for details.
* Implementations may choose to acknowledge "LONG",
* "SHORT", or other abbreviated key IDs, but only the full
* fingerprint is guaranteed to work. In gpg, the full fingerprint can be
* retrieved from the `fpr` field returned when calling --list-keys with
* --with-colons. For example: ``` gpg --with-colons --with-fingerprint
* --force-v4-certs \ --list-keys attester@example.com
* tru::1:1513631572:0:3:1:5 pub:...<SNIP>...
* fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the
* fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
*/
pgpKeyId?: string;
/**
* The raw content of the signature, as output by GNU Privacy Guard (GPG) or
* equivalent. Since this message only supports attached signatures, the
* payload that was signed must be attached. While the signature format
* supported is dependent on the verification implementation, currently only
* ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than
* `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor
* --output=signature.gpg payload.json` will create the signature content
* expected in this field in `signature.gpg` for the `payload.json`
* attestation payload.
*/
signature?: string;
}
/**
* Defines an Identity and Access Management (IAM) policy. It is used to
* specify access control policies for Cloud Platform resources. A `Policy`
* consists of a list of `bindings`. A `binding` binds a list of `members` to
* a `role`, where the members can be user accounts, Google groups, Google
* domains, and service accounts. A `role` is a named list of permissions
* defined by IAM. **JSON Example** { "bindings": [ {
* "role": "roles/owner", "members": [
* "user:mike@example.com", "group:admins@example.com",
* "domain:google.com",
* "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, {
* "role": "roles/viewer", "members":
* ["user:sean@example.com"] } ] } **YAML
* Example** bindings: - members: - user:mike@example.com -
* group:admins@example.com - domain:google.com -
* serviceAccount:my-other-app@appspot.gserviceaccount.com role:
* roles/owner - members: - user:sean@example.com role:
* roles/viewer For a description of IAM and its features, see the [IAM
* developer's guide](https://cloud.google.com/iam/docs).
*/
interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members` to a `role`. `bindings` with no members
* will result in an error.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help
* prevent simultaneous updates of a policy from overwriting each other. It
* is strongly suggested that systems make use of the `etag` in the
* read-modify-write cycle to perform policy updates in order to avoid race
* conditions: An `etag` is returned in the response to `getIamPolicy`, and
* systems are expected to put that etag in the request to `setIamPolicy` to
* ensure that their change will be applied to the same version of the
* policy. If no `etag` is provided in the call to `setIamPolicy`, then the
* existing policy is overwritten blindly.
*/
etag?: string;
/**
* Deprecated.
*/
version?: number;
}
/**
* Metadata for any related URL information
*/
interface Schema$RelatedUrl {
/**
* Label to describe usage of the URL
*/
label?: string;
/**
* Specific URL to associate with the note
*/
url?: string;
}
/**
* RepoSource describes the location of the source in a Google Cloud Source
* Repository.
*/
interface Schema$RepoSource {
/**
* Name of the branch to build.
*/
branchName?: string;
/**
* Explicit commit SHA to build.
*/
commitSha?: string;
/**
* ID of the project that owns the repo.
*/
projectId?: string;
/**
* Name of the repo.
*/
repoName?: string;
/**
* Name of the tag to build.
*/
tagName?: string;
}
/**
* Resource is an entity that can have metadata. E.g., a Docker image.
*/
interface Schema$Resource {
/**
* The hash of the resource content. E.g., the Docker digest.
*/
contentHash?: Schema$Hash;
/**
* The name of the resource. E.g., the name of a Docker image -
* "Debian".
*/
name?: string;
/**
* The unique URI of the resource. E.g.,
* "https://gcr.io/project/image@sha256:foo" for a Docker image.
*/
uri?: string;
}
/**
* Indicates various scans and whether they are turned on or off.
*/
interface Schema$ScanConfig {
/**
* Output only. The time this scan config was created.
*/
createTime?: string;
/**
* Output only. A human-readable description of what the `ScanConfig` does.
*/
description?: string;
/**
* Indicates whether the Scan is enabled.
*/
enabled?: boolean;
/**
* Output only. The name of the ScanConfig in the form
* “projects/{project_id}/scanConfigs/{scan_config_id}".
*/
name?: string;
/**
* Output only. The time this scan config was last updated.
*/
updateTime?: string;
}
/**
* Request message for `SetIamPolicy` method.
*/
interface Schema$SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size
* of the policy is limited to a few 10s of KB. An empty policy is a valid
* policy but certain Cloud Platform services (such as Projects) might
* reject them.
*/
policy?: Schema$Policy;
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify.
* Only the fields in the mask will be modified. If no mask is provided, the
* following default mask is used: paths: "bindings, etag" This
* field is only used by Cloud IAM.
*/
updateMask?: string;
}
/**
* The number of occurrences created for a specific severity.
*/
interface Schema$SeverityCount {
/**
* The number of occurrences with the severity.
*/
count?: string;
/**
* The severity of the occurrences.
*/
severity?: string;
}
/**
* Source describes the location of the source used for the build.
*/
interface Schema$Source {
/**
* If provided, some of the source code used for the build may be found in
* these locations, in the case where the source repository had multiple
* remotes or submodules. This list will not include the context specified
* in the context field.
*/
additionalContexts?: Schema$GoogleDevtoolsContaineranalysisV1alpha1SourceContext[];
/**
* If provided, the input binary artifacts for the build came from this
* location.
*/
artifactStorageSource?: Schema$StorageSource;
/**
* If provided, the source code used for the build came from this location.
*/
context?: Schema$GoogleDevtoolsContaineranalysisV1alpha1SourceContext;
/**
* Hash(es) of the build source, which can be used to verify that the
* original source integrity was maintained in the build. The keys to this
* map are file paths used as build source and the values contain the hash
* values for those files. If the build source came in a single package
* such as a gzipped tarfile (.tar.gz), the FileHash will be for the single
* path to that file.
*/
fileHashes?: {
[key: string]: Schema$FileHashes;
};
/**
* If provided, get source from this location in a Cloud Repo.
*/
repoSource?: Schema$RepoSource;
/**
* If provided, get the source from this location in in Google Cloud
* Storage.
*/
storageSource?: Schema$StorageSource;
}
/**
* The `Status` type defines a logical error model that is suitable for
* different programming environments, including REST APIs and RPC APIs. It is
* used by [gRPC](https://github.com/grpc). The error model is designed to be:
* - Simple to use and understand for most users - Flexible enough to meet
* unexpected needs # Overview The `Status` message contains three pieces of
* data: error code, error message, and error details. The error code should
* be an enum value of google.rpc.Code, but it may accept additional error
* codes if needed. The error message should be a developer-facing English
* message that helps developers *understand* and *resolve* the error. If a
* localized user-facing error message is needed, put the localized message in
* the error details or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that can be used for
* common error conditions. # Language mapping The `Status` message is the
* logical representation of the error model, but it is not necessarily the
* actual wire format. When the `Status` message is exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, but more likely mapped to some error codes in C. # Other uses The
* error model and the `Status` message can be used in a variety of
* environments, either with or without APIs, to provide a consistent
* developer experience across different environments. Example uses of this
* error model include: - Partial errors. If a service needs to return
* partial errors to the client, it may embed the `Status` in the normal
* response to indicate the partial errors. - Workflow errors. A typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the `Status` message. - Logging. If some API errors are stored in
* logs, the message `Status` could be used directly after any stripping
* needed for security/privacy reasons.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set
* of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}>;
/**
* A developer-facing error message, which should be in English. Any
* user-facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
* StorageSource describes the location of the source in an archive file in
* Google Cloud Storage.
*/
interface Schema$StorageSource {
/**
* Google Cloud Storage bucket containing source (see [Bucket Name
* Requirements]
* (https://cloud.google.com/storage/docs/bucket-naming#requirements)).
*/
bucket?: string;
/**
* Google Cloud Storage generation for the object.
*/
generation?: string;
/**
* Google Cloud Storage object containing source.
*/
object?: string;
}
/**
* Request message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsRequest {
/**
* The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed.
* For more information see [IAM
* Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[];
}
/**
* Response message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is
* allowed.
*/
permissions?: string[];
}
/**
* Request for updating an existing operation
*/
interface Schema$UpdateOperationRequest {
/**
* The operation to create.
*/
operation?: Schema$Operation;
/**
* The fields to update.
*/
updateMask?: string;
}
/**
* Version contains structured information about the version of the package.
* For a discussion of this in Debian/Ubuntu:
* http://serverfault.com/questions/604541/debian-packages-version-convention
* For a discussion of this in Redhat/Fedora/Centos:
* http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
*/
interface Schema$Version {
/**
* Used to correct mistakes in the version numbering scheme.
*/
epoch?: number;
/**
* Distinguish between sentinel MIN/MAX versions and normal versions. If
* kind is not NORMAL, then the other fields are ignored.
*/
kind?: string;
/**
* The main part of the version name.
*/
name?: string;
/**
* The iteration of the package build from the above version.
*/
revision?: string;
}
/**
* Used by Occurrence to point to where the vulnerability exists and how to
* fix it.
*/
interface Schema$VulnerabilityDetails {
/**
* Output only. The CVSS score of this vulnerability. CVSS score is on a
* scale of 0-10 where 0 indicates low severity and 10 indicates high
* severity.
*/
cvssScore?: number;
/**
* The distro assigned severity for this vulnerability when that is
* available and note provider assigned severity when distro has not yet
* assigned a severity for this vulnerability.
*/
effectiveSeverity?: string;
/**
* The set of affected locations and their fixes (if available) within the
* associated resource.
*/
packageIssue?: Schema$PackageIssue[];
/**
* Output only. The note provider assigned Severity of the vulnerability.
*/
severity?: string;
/**
* The type of package; whether native or non native(ruby gems, node.js
* packages etc)
*/
type?: string;
}
/**
* The location of the vulnerability
*/
interface Schema$VulnerabilityLocation {
/**
* The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
* format. Examples include distro or storage location for vulnerable jar.
* This field can be used as a filter in list requests.
*/
cpeUri?: string;
/**
* The package being described.
*/
package?: string;
/**
* The version of the package being described. This field can be used as a
* filter in list requests.
*/
version?: Schema$Version;
}
/**
* VulnerabilityType provides metadata about a security vulnerability.
*/
interface Schema$VulnerabilityType {
/**
* The CVSS score for this Vulnerability.
*/
cvssScore?: number;
/**
* All information about the package to specifically identify this
* vulnerability. One entry per (version range and cpe_uri) the package
* vulnerability has manifested in.
*/
details?: Schema$Detail[];
/**
* Note provider assigned impact of the vulnerability
*/
severity?: string;
}
class Resource$Projects {
context: APIRequestContext;
notes: Resource$Projects$Notes;
occurrences: Resource$Projects$Occurrences;
operations: Resource$Projects$Operations;
scanConfigs: Resource$Projects$Scanconfigs;
constructor(context: APIRequestContext);
}
class Resource$Projects$Notes {
context: APIRequestContext;
occurrences: Resource$Projects$Notes$Occurrences;
constructor(context: APIRequestContext);
/**
* containeranalysis.projects.notes.create
* @desc Creates a new `Note`.
* @alias containeranalysis.projects.notes.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.name The name of the project. Should be of the form "providers/{provider_id}". @Deprecated
* @param {string=} params.noteId The ID to use for this note.
* @param {string} params.parent This field contains the project Id for example: "projects/{project_id}
* @param {().Note} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Notes$Create, options?: MethodOptions): GaxiosPromise<Schema$Note>;
create(params: Params$Resource$Projects$Notes$Create, options: MethodOptions | BodyResponseCallback<Schema$Note>, callback: BodyResponseCallback<Schema$Note>): void;
create(params: Params$Resource$Projects$Notes$Create, callback: BodyResponseCallback<Schema$Note>): void;
create(callback: BodyResponseCallback<Schema$Note>): void;
/**
* containeranalysis.projects.notes.delete
* @desc Deletes the given `Note` from the system.
* @alias containeranalysis.projects.notes.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Notes$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Notes$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Notes$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* containeranalysis.projects.notes.get
* @desc Returns the requested `Note`.
* @alias containeranalysis.projects.notes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Notes$Get, options?: MethodOptions): GaxiosPromise<Schema$Note>;
get(params: Params$Resource$Projects$Notes$Get, options: MethodOptions | BodyResponseCallback<Schema$Note>, callback: BodyResponseCallback<Schema$Note>): void;
get(params: Params$Resource$Projects$Notes$Get, callback: BodyResponseCallback<Schema$Note>): void;
get(callback: BodyResponseCallback<Schema$Note>): void;
/**
* containeranalysis.projects.notes.getIamPolicy
* @desc Gets the access control policy for a note or an `Occurrence`
* resource. Requires `containeranalysis.notes.setIamPolicy` or
* `containeranalysis.occurrences.setIamPolicy` permission if the resource
* is a note or occurrence, respectively. Attempting to call this method on
* a resource without the required permission will result in a
* `PERMISSION_DENIED` error. Attempting to call this method on a
* non-existent resource will result in a `NOT_FOUND` error if the user has
* list permission on the project, or a `PERMISSION_DENIED` error otherwise.
* The resource takes the following formats:
* `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and
* projects/{PROJECT_ID}/notes/{NOTE_ID} for notes
* @alias containeranalysis.projects.notes.getIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
* @param {().GetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getIamPolicy(params?: Params$Resource$Projects$Notes$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Projects$Notes$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Projects$Notes$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* containeranalysis.projects.notes.list
* @desc Lists all `Notes` for a given project.
* @alias containeranalysis.projects.notes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The filter expression.
* @param {string=} params.name The name field will contain the project Id for example: "providers/{provider_id} @Deprecated
* @param {integer=} params.pageSize Number of notes to return in the list.
* @param {string=} params.pageToken Token to provide to skip to a particular spot in the list.
* @param {string} params.parent This field contains the project Id for example: "projects/{PROJECT_ID}".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Notes$List, options?: MethodOptions): GaxiosPromise<Schema$ListNotesResponse>;
list(params: Params$Resource$Projects$Notes$List, options: MethodOptions | BodyResponseCallback<Schema$ListNotesResponse>, callback: BodyResponseCallback<Schema$ListNotesResponse>): void;
list(params: Params$Resource$Projects$Notes$List, callback: BodyResponseCallback<Schema$ListNotesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListNotesResponse>): void;
/**
* containeranalysis.projects.notes.patch
* @desc Updates an existing `Note`.
* @alias containeranalysis.projects.notes.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the note. Should be of the form "projects/{provider_id}/notes/{note_id}".
* @param {string=} params.updateMask The fields to update.
* @param {().Note} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Notes$Patch, options?: MethodOptions): GaxiosPromise<Schema$Note>;
patch(params: Params$Resource$Projects$Notes$Patch, options: MethodOptions | BodyResponseCallback<Schema$Note>, callback: BodyResponseCallback<Schema$Note>): void;
patch(params: Params$Resource$Projects$Notes$Patch, callback: BodyResponseCallback<Schema$Note>): void;
patch(callback: BodyResponseCallback<Schema$Note>): void;
/**
* containeranalysis.projects.notes.setIamPolicy
* @desc Sets the access control policy on the specified `Note` or
* `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or
* `containeranalysis.occurrences.setIamPolicy` permission if the resource
* is a `Note` or an `Occurrence`, respectively. Attempting to call this
* method without these permissions will result in a ` `PERMISSION_DENIED`
* error. Attempting to call this method on a non-existent resource will
* result in a `NOT_FOUND` error if the user has
* `containeranalysis.notes.list` permission on a `Note` or
* `containeranalysis.occurrences.list` on an `Occurrence`, or a
* `PERMISSION_DENIED` error otherwise. The resource takes the following
* formats: `projects/{projectid}/occurrences/{occurrenceid}` for
* occurrences and projects/{projectid}/notes/{noteid} for notes
* @alias containeranalysis.projects.notes.setIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
* @param {().SetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
setIamPolicy(params?: Params$Resource$Projects$Notes$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Projects$Notes$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Projects$Notes$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* containeranalysis.projects.notes.testIamPermissions
* @desc Returns the permissions that a caller has on the specified note or
* occurrence resource. Requires list permission on the project (for
* example, "storage.objects.list" on the containing bucket for testing
* permission of an object). Attempting to call this method on a
* non-existent resource will result in a `NOT_FOUND` error if the user has
* list permission on the project, or a `PERMISSION_DENIED` error otherwise.
* The resource takes the following formats:
* `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and
* `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`
* @alias containeranalysis.projects.notes.testIamPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* @param {().TestIamPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
testIamPermissions(params?: Params$Resource$Projects$Notes$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Notes$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Notes$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
}
interface Params$Resource$Projects$Notes$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the project. Should be of the form "providers/{provider_id}".
* @Deprecated
*/
name?: string;
/**
* The ID to use for this note.
*/
noteId?: string;
/**
* This field contains the project Id for example: "projects/{project_id}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Note;
}
interface Params$Resource$Projects$Notes$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the note in the form of
* "providers/{provider_id}/notes/{NOTE_ID}"
*/
name?: string;
}
interface Params$Resource$Projects$Notes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the note in the form of
* "providers/{provider_id}/notes/{NOTE_ID}"
*/
name?: string;
}
interface Params$Resource$Projects$Notes$Getiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GetIamPolicyRequest;
}
interface Params$Resource$Projects$Notes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The filter expression.
*/
filter?: string;
/**
* The name field will contain the project Id for example:
* "providers/{provider_id} @Deprecated
*/
name?: string;
/**
* Number of notes to return in the list.
*/
pageSize?: number;
/**
* Token to provide to skip to a particular spot in the list.
*/
pageToken?: string;
/**
* This field contains the project Id for example: "projects/{PROJECT_ID}".
*/
parent?: string;
}
interface Params$Resource$Projects$Notes$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the note. Should be of the form
* "projects/{provider_id}/notes/{note_id}".
*/
name?: string;
/**
* The fields to update.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Note;
}
interface Params$Resource$Projects$Notes$Setiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SetIamPolicyRequest;
}
interface Params$Resource$Projects$Notes$Testiampermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
class Resource$Projects$Notes$Occurrences {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* containeranalysis.projects.notes.occurrences.list
* @desc Lists `Occurrences` referencing the specified `Note`. Use this
* method to get all occurrences referencing your `Note` across all your
* customer projects.
* @alias containeranalysis.projects.notes.occurrences.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The filter expression.
* @param {string} params.name The name field will contain the note name for example: "provider/{provider_id}/notes/{note_id}"
* @param {integer=} params.pageSize Number of notes to return in the list.
* @param {string=} params.pageToken Token to provide to skip to a particular spot in the list.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Notes$Occurrences$List, options?: MethodOptions): GaxiosPromise<Schema$ListNoteOccurrencesResponse>;
list(params: Params$Resource$Projects$Notes$Occurrences$List, options: MethodOptions | BodyResponseCallback<Schema$ListNoteOccurrencesResponse>, callback: BodyResponseCallback<Schema$ListNoteOccurrencesResponse>): void;
list(params: Params$Resource$Projects$Notes$Occurrences$List, callback: BodyResponseCallback<Schema$ListNoteOccurrencesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListNoteOccurrencesResponse>): void;
}
interface Params$Resource$Projects$Notes$Occurrences$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The filter expression.
*/
filter?: string;
/**
* The name field will contain the note name for example:
* "provider/{provider_id}/notes/{note_id}"
*/
name?: string;
/**
* Number of notes to return in the list.
*/
pageSize?: number;
/**
* Token to provide to skip to a particular spot in the list.
*/
pageToken?: string;
}
class Resource$Projects$Occurrences {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* containeranalysis.projects.occurrences.create
* @desc Creates a new `Occurrence`. Use this method to create `Occurrences`
* for a resource.
* @alias containeranalysis.projects.occurrences.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.name The name of the project. Should be of the form "projects/{project_id}". @Deprecated
* @param {string} params.parent This field contains the project Id for example: "projects/{project_id}"
* @param {().Occurrence} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Occurrences$Create, options?: MethodOptions): GaxiosPromise<Schema$Occurrence>;
create(params: Params$Resource$Projects$Occurrences$Create, options: MethodOptions | BodyResponseCallback<Schema$Occurrence>, callback: BodyResponseCallback<Schema$Occurrence>): void;
create(params: Params$Resource$Projects$Occurrences$Create, callback: BodyResponseCallback<Schema$Occurrence>): void;
create(callback: BodyResponseCallback<Schema$Occurrence>): void;
/**
* containeranalysis.projects.occurrences.delete
* @desc Deletes the given `Occurrence` from the system. Use this when an
* `Occurrence` is no longer applicable for the given resource.
* @alias containeranalysis.projects.occurrences.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the occurrence in the form of "projects/{project_id}/occurrences/{OCCURRENCE_ID}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Occurrences$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Occurrences$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Occurrences$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* containeranalysis.projects.occurrences.get
* @desc Returns the requested `Occurrence`.
* @alias containeranalysis.projects.occurrences.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the occurrence of the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Occurrences$Get, options?: MethodOptions): GaxiosPromise<Schema$Occurrence>;
get(params: Params$Resource$Projects$Occurrences$Get, options: MethodOptions | BodyResponseCallback<Schema$Occurrence>, callback: BodyResponseCallback<Schema$Occurrence>): void;
get(params: Params$Resource$Projects$Occurrences$Get, callback: BodyResponseCallback<Schema$Occurrence>): void;
get(callback: BodyResponseCallback<Schema$Occurrence>): void;
/**
* containeranalysis.projects.occurrences.getIamPolicy
* @desc Gets the access control policy for a note or an `Occurrence`
* resource. Requires `containeranalysis.notes.setIamPolicy` or
* `containeranalysis.occurrences.setIamPolicy` permission if the resource
* is a note or occurrence, respectively. Attempting to call this method on
* a resource without the required permission will result in a
* `PERMISSION_DENIED` error. Attempting to call this method on a
* non-existent resource will result in a `NOT_FOUND` error if the user has
* list permission on the project, or a `PERMISSION_DENIED` error otherwise.
* The resource takes the following formats:
* `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and
* projects/{PROJECT_ID}/notes/{NOTE_ID} for notes
* @alias containeranalysis.projects.occurrences.getIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
* @param {().GetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getIamPolicy(params?: Params$Resource$Projects$Occurrences$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Projects$Occurrences$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Projects$Occurrences$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* containeranalysis.projects.occurrences.getNotes
* @desc Gets the `Note` attached to the given `Occurrence`.
* @alias containeranalysis.projects.occurrences.getNotes
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the occurrence in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getNotes(params?: Params$Resource$Projects$Occurrences$Getnotes, options?: MethodOptions): GaxiosPromise<Schema$Note>;
getNotes(params: Params$Resource$Projects$Occurrences$Getnotes, options: MethodOptions | BodyResponseCallback<Schema$Note>, callback: BodyResponseCallback<Schema$Note>): void;
getNotes(params: Params$Resource$Projects$Occurrences$Getnotes, callback: BodyResponseCallback<Schema$Note>): void;
getNotes(callback: BodyResponseCallback<Schema$Note>): void;
/**
* containeranalysis.projects.occurrences.getVulnerabilitySummary
* @desc Gets a summary of the number and severity of occurrences.
* @alias containeranalysis.projects.occurrences.getVulnerabilitySummary
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The filter expression.
* @param {string} params.parent This contains the project Id for example: projects/{project_id}
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getVulnerabilitySummary(params?: Params$Resource$Projects$Occurrences$Getvulnerabilitysummary, options?: MethodOptions): GaxiosPromise<Schema$GetVulnzOccurrencesSummaryResponse>;
getVulnerabilitySummary(params: Params$Resource$Projects$Occurrences$Getvulnerabilitysummary, options: MethodOptions | BodyResponseCallback<Schema$GetVulnzOccurrencesSummaryResponse>, callback: BodyResponseCallback<Schema$GetVulnzOccurrencesSummaryResponse>): void;
getVulnerabilitySummary(params: Params$Resource$Projects$Occurrences$Getvulnerabilitysummary, callback: BodyResponseCallback<Schema$GetVulnzOccurrencesSummaryResponse>): void;
getVulnerabilitySummary(callback: BodyResponseCallback<Schema$GetVulnzOccurrencesSummaryResponse>): void;
/**
* containeranalysis.projects.occurrences.list
* @desc Lists active `Occurrences` for a given project matching the
* filters.
* @alias containeranalysis.projects.occurrences.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The filter expression.
* @param {string=} params.kind The kind of occurrences to filter on.
* @param {string=} params.name The name field contains the project Id. For example: "projects/{project_id} @Deprecated
* @param {integer=} params.pageSize Number of occurrences to return in the list.
* @param {string=} params.pageToken Token to provide to skip to a particular spot in the list.
* @param {string} params.parent This contains the project Id for example: projects/{project_id}.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Occurrences$List, options?: MethodOptions): GaxiosPromise<Schema$ListOccurrencesResponse>;
list(params: Params$Resource$Projects$Occurrences$List, options: MethodOptions | BodyResponseCallback<Schema$ListOccurrencesResponse>, callback: BodyResponseCallback<Schema$ListOccurrencesResponse>): void;
list(params: Params$Resource$Projects$Occurrences$List, callback: BodyResponseCallback<Schema$ListOccurrencesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOccurrencesResponse>): void;
/**
* containeranalysis.projects.occurrences.patch
* @desc Updates an existing occurrence.
* @alias containeranalysis.projects.occurrences.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the occurrence. Should be of the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}".
* @param {string=} params.updateMask The fields to update.
* @param {().Occurrence} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Occurrences$Patch, options?: MethodOptions): GaxiosPromise<Schema$Occurrence>;
patch(params: Params$Resource$Projects$Occurrences$Patch, options: MethodOptions | BodyResponseCallback<Schema$Occurrence>, callback: BodyResponseCallback<Schema$Occurrence>): void;
patch(params: Params$Resource$Projects$Occurrences$Patch, callback: BodyResponseCallback<Schema$Occurrence>): void;
patch(callback: BodyResponseCallback<Schema$Occurrence>): void;
/**
* containeranalysis.projects.occurrences.setIamPolicy
* @desc Sets the access control policy on the specified `Note` or
* `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or
* `containeranalysis.occurrences.setIamPolicy` permission if the resource
* is a `Note` or an `Occurrence`, respectively. Attempting to call this
* method without these permissions will result in a ` `PERMISSION_DENIED`
* error. Attempting to call this method on a non-existent resource will
* result in a `NOT_FOUND` error if the user has
* `containeranalysis.notes.list` permission on a `Note` or
* `containeranalysis.occurrences.list` on an `Occurrence`, or a
* `PERMISSION_DENIED` error otherwise. The resource takes the following
* formats: `projects/{projectid}/occurrences/{occurrenceid}` for
* occurrences and projects/{projectid}/notes/{noteid} for notes
* @alias containeranalysis.projects.occurrences.setIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
* @param {().SetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
setIamPolicy(params?: Params$Resource$Projects$Occurrences$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Projects$Occurrences$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Projects$Occurrences$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* containeranalysis.projects.occurrences.testIamPermissions
* @desc Returns the permissions that a caller has on the specified note or
* occurrence resource. Requires list permission on the project (for
* example, "storage.objects.list" on the containing bucket for testing
* permission of an object). Attempting to call this method on a
* non-existent resource will result in a `NOT_FOUND` error if the user has
* list permission on the project, or a `PERMISSION_DENIED` error otherwise.
* The resource takes the following formats:
* `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and
* `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`
* @alias containeranalysis.projects.occurrences.testIamPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* @param {().TestIamPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
testIamPermissions(params?: Params$Resource$Projects$Occurrences$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Occurrences$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Occurrences$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
}
interface Params$Resource$Projects$Occurrences$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the project. Should be of the form "projects/{project_id}".
* @Deprecated
*/
name?: string;
/**
* This field contains the project Id for example: "projects/{project_id}"
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Occurrence;
}
interface Params$Resource$Projects$Occurrences$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the occurrence in the form of
* "projects/{project_id}/occurrences/{OCCURRENCE_ID}"
*/
name?: string;
}
interface Params$Resource$Projects$Occurrences$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the occurrence of the form
* "projects/{project_id}/occurrences/{OCCURRENCE_ID}"
*/
name?: string;
}
interface Params$Resource$Projects$Occurrences$Getiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GetIamPolicyRequest;
}
interface Params$Resource$Projects$Occurrences$Getnotes extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the occurrence in the form
* "projects/{project_id}/occurrences/{OCCURRENCE_ID}"
*/
name?: string;
}
interface Params$Resource$Projects$Occurrences$Getvulnerabilitysummary extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The filter expression.
*/
filter?: string;
/**
* This contains the project Id for example: projects/{project_id}
*/
parent?: string;
}
interface Params$Resource$Projects$Occurrences$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The filter expression.
*/
filter?: string;
/**
* The kind of occurrences to filter on.
*/
kind?: string;
/**
* The name field contains the project Id. For example:
* "projects/{project_id} @Deprecated
*/
name?: string;
/**
* Number of occurrences to return in the list.
*/
pageSize?: number;
/**
* Token to provide to skip to a particular spot in the list.
*/
pageToken?: string;
/**
* This contains the project Id for example: projects/{project_id}.
*/
parent?: string;
}
interface Params$Resource$Projects$Occurrences$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the occurrence. Should be of the form
* "projects/{project_id}/occurrences/{OCCURRENCE_ID}".
*/
name?: string;
/**
* The fields to update.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Occurrence;
}
interface Params$Resource$Projects$Occurrences$Setiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SetIamPolicyRequest;
}
interface Params$Resource$Projects$Occurrences$Testiampermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
class Resource$Projects$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* containeranalysis.projects.operations.create
* @desc Creates a new `Operation`.
* @alias containeranalysis.projects.operations.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The project Id that this operation should be created under.
* @param {().CreateOperationRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Operations$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Operations$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Operations$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* containeranalysis.projects.operations.patch
* @desc Updates an existing operation returns an error if operation does
* not exist. The only valid operations are to update mark the done bit
* change the result.
* @alias containeranalysis.projects.operations.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the Operation. Should be of the form "projects/{provider_id}/operations/{operation_id}".
* @param {().UpdateOperationRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Operations$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Projects$Operations$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Projects$Operations$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Projects$Operations$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The project Id that this operation should be created under.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreateOperationRequest;
}
interface Params$Resource$Projects$Operations$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the Operation. Should be of the form
* "projects/{provider_id}/operations/{operation_id}".
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateOperationRequest;
}
class Resource$Projects$Scanconfigs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* containeranalysis.projects.scanConfigs.get
* @desc Gets a specific scan configuration for a project.
* @alias containeranalysis.projects.scanConfigs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the ScanConfig in the form projects/{project_id}/scanConfigs/{scan_config_id}
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Scanconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$ScanConfig>;
get(params: Params$Resource$Projects$Scanconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$ScanConfig>, callback: BodyResponseCallback<Schema$ScanConfig>): void;
get(params: Params$Resource$Projects$Scanconfigs$Get, callback: BodyResponseCallback<Schema$ScanConfig>): void;
get(callback: BodyResponseCallback<Schema$ScanConfig>): void;
/**
* containeranalysis.projects.scanConfigs.list
* @desc Lists scan configurations for a project.
* @alias containeranalysis.projects.scanConfigs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The filter expression.
* @param {integer=} params.pageSize The number of items to return.
* @param {string=} params.pageToken The page token to use for the next request.
* @param {string} params.parent This containers the project Id i.e.: projects/{project_id}
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Scanconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$ListScanConfigsResponse>;
list(params: Params$Resource$Projects$Scanconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$ListScanConfigsResponse>, callback: BodyResponseCallback<Schema$ListScanConfigsResponse>): void;
list(params: Params$Resource$Projects$Scanconfigs$List, callback: BodyResponseCallback<Schema$ListScanConfigsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListScanConfigsResponse>): void;
/**
* containeranalysis.projects.scanConfigs.patch
* @desc Updates the scan configuration to a new value.
* @alias containeranalysis.projects.scanConfigs.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The scan config to update of the form projects/{project_id}/scanConfigs/{scan_config_id}.
* @param {string=} params.updateMask The fields to update.
* @param {().ScanConfig} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Scanconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$ScanConfig>;
patch(params: Params$Resource$Projects$Scanconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$ScanConfig>, callback: BodyResponseCallback<Schema$ScanConfig>): void;
patch(params: Params$Resource$Projects$Scanconfigs$Patch, callback: BodyResponseCallback<Schema$ScanConfig>): void;
patch(callback: BodyResponseCallback<Schema$ScanConfig>): void;
}
interface Params$Resource$Projects$Scanconfigs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the ScanConfig in the form
* projects/{project_id}/scanConfigs/{scan_config_id}
*/
name?: string;
}
interface Params$Resource$Projects$Scanconfigs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The filter expression.
*/
filter?: string;
/**
* The number of items to return.
*/
pageSize?: number;
/**
* The page token to use for the next request.
*/
pageToken?: string;
/**
* This containers the project Id i.e.: projects/{project_id}
*/
parent?: string;
}
interface Params$Resource$Projects$Scanconfigs$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The scan config to update of the form
* projects/{project_id}/scanConfigs/{scan_config_id}.
*/
name?: string;
/**
* The fields to update.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ScanConfig;
}
class Resource$Providers {
context: APIRequestContext;
notes: Resource$Providers$Notes;
constructor(context: APIRequestContext);
}
class Resource$Providers$Notes {
context: APIRequestContext;
occurrences: Resource$Providers$Notes$Occurrences;
constructor(context: APIRequestContext);
/**
* containeranalysis.providers.notes.create
* @desc Creates a new `Note`.
* @alias containeranalysis.providers.notes.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the project. Should be of the form "providers/{provider_id}". @Deprecated
* @param {string=} params.noteId The ID to use for this note.
* @param {string=} params.parent This field contains the project Id for example: "projects/{project_id}
* @param {().Note} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Providers$Notes$Create, options?: MethodOptions): GaxiosPromise<Schema$Note>;
create(params: Params$Resource$Providers$Notes$Create, options: MethodOptions | BodyResponseCallback<Schema$Note>, callback: BodyResponseCallback<Schema$Note>): void;
create(params: Params$Resource$Providers$Notes$Create, callback: BodyResponseCallback<Schema$Note>): void;
create(callback: BodyResponseCallback<Schema$Note>): void;
/**
* containeranalysis.providers.notes.delete
* @desc Deletes the given `Note` from the system.
* @alias containeranalysis.providers.notes.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Providers$Notes$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Providers$Notes$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Providers$Notes$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* containeranalysis.providers.notes.get
* @desc Returns the requested `Note`.
* @alias containeranalysis.providers.notes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Providers$Notes$Get, options?: MethodOptions): GaxiosPromise<Schema$Note>;
get(params: Params$Resource$Providers$Notes$Get, options: MethodOptions | BodyResponseCallback<Schema$Note>, callback: BodyResponseCallback<Schema$Note>): void;
get(params: Params$Resource$Providers$Notes$Get, callback: BodyResponseCallback<Schema$Note>): void;
get(callback: BodyResponseCallback<Schema$Note>): void;
/**
* containeranalysis.providers.notes.getIamPolicy
* @desc Gets the access control policy for a note or an `Occurrence`
* resource. Requires `containeranalysis.notes.setIamPolicy` or
* `containeranalysis.occurrences.setIamPolicy` permission if the resource
* is a note or occurrence, respectively. Attempting to call this method on
* a resource without the required permission will result in a
* `PERMISSION_DENIED` error. Attempting to call this method on a
* non-existent resource will result in a `NOT_FOUND` error if the user has
* list permission on the project, or a `PERMISSION_DENIED` error otherwise.
* The resource takes the following formats:
* `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and
* projects/{PROJECT_ID}/notes/{NOTE_ID} for notes
* @alias containeranalysis.providers.notes.getIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
* @param {().GetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getIamPolicy(params?: Params$Resource$Providers$Notes$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Providers$Notes$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Providers$Notes$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* containeranalysis.providers.notes.list
* @desc Lists all `Notes` for a given project.
* @alias containeranalysis.providers.notes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The filter expression.
* @param {string} params.name The name field will contain the project Id for example: "providers/{provider_id} @Deprecated
* @param {integer=} params.pageSize Number of notes to return in the list.
* @param {string=} params.pageToken Token to provide to skip to a particular spot in the list.
* @param {string=} params.parent This field contains the project Id for example: "projects/{PROJECT_ID}".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Providers$Notes$List, options?: MethodOptions): GaxiosPromise<Schema$ListNotesResponse>;
list(params: Params$Resource$Providers$Notes$List, options: MethodOptions | BodyResponseCallback<Schema$ListNotesResponse>, callback: BodyResponseCallback<Schema$ListNotesResponse>): void;
list(params: Params$Resource$Providers$Notes$List, callback: BodyResponseCallback<Schema$ListNotesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListNotesResponse>): void;
/**
* containeranalysis.providers.notes.patch
* @desc Updates an existing `Note`.
* @alias containeranalysis.providers.notes.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the note. Should be of the form "projects/{provider_id}/notes/{note_id}".
* @param {string=} params.updateMask The fields to update.
* @param {().Note} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Providers$Notes$Patch, options?: MethodOptions): GaxiosPromise<Schema$Note>;
patch(params: Params$Resource$Providers$Notes$Patch, options: MethodOptions | BodyResponseCallback<Schema$Note>, callback: BodyResponseCallback<Schema$Note>): void;
patch(params: Params$Resource$Providers$Notes$Patch, callback: BodyResponseCallback<Schema$Note>): void;
patch(callback: BodyResponseCallback<Schema$Note>): void;
/**
* containeranalysis.providers.notes.setIamPolicy
* @desc Sets the access control policy on the specified `Note` or
* `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or
* `containeranalysis.occurrences.setIamPolicy` permission if the resource
* is a `Note` or an `Occurrence`, respectively. Attempting to call this
* method without these permissions will result in a ` `PERMISSION_DENIED`
* error. Attempting to call this method on a non-existent resource will
* result in a `NOT_FOUND` error if the user has
* `containeranalysis.notes.list` permission on a `Note` or
* `containeranalysis.occurrences.list` on an `Occurrence`, or a
* `PERMISSION_DENIED` error otherwise. The resource takes the following
* formats: `projects/{projectid}/occurrences/{occurrenceid}` for
* occurrences and projects/{projectid}/notes/{noteid} for notes
* @alias containeranalysis.providers.notes.setIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
* @param {().SetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
setIamPolicy(params?: Params$Resource$Providers$Notes$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Providers$Notes$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Providers$Notes$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* containeranalysis.providers.notes.testIamPermissions
* @desc Returns the permissions that a caller has on the specified note or
* occurrence resource. Requires list permission on the project (for
* example, "storage.objects.list" on the containing bucket for testing
* permission of an object). Attempting to call this method on a
* non-existent resource will result in a `NOT_FOUND` error if the user has
* list permission on the project, or a `PERMISSION_DENIED` error otherwise.
* The resource takes the following formats:
* `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and
* `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`
* @alias containeranalysis.providers.notes.testIamPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* @param {().TestIamPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
testIamPermissions(params?: Params$Resource$Providers$Notes$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Providers$Notes$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Providers$Notes$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
}
interface Params$Resource$Providers$Notes$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the project. Should be of the form "providers/{provider_id}".
* @Deprecated
*/
name?: string;
/**
* The ID to use for this note.
*/
noteId?: string;
/**
* This field contains the project Id for example: "projects/{project_id}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Note;
}
interface Params$Resource$Providers$Notes$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the note in the form of
* "providers/{provider_id}/notes/{NOTE_ID}"
*/
name?: string;
}
interface Params$Resource$Providers$Notes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the note in the form of
* "providers/{provider_id}/notes/{NOTE_ID}"
*/
name?: string;
}
interface Params$Resource$Providers$Notes$Getiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GetIamPolicyRequest;
}
interface Params$Resource$Providers$Notes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The filter expression.
*/
filter?: string;
/**
* The name field will contain the project Id for example:
* "providers/{provider_id} @Deprecated
*/
name?: string;
/**
* Number of notes to return in the list.
*/
pageSize?: number;
/**
* Token to provide to skip to a particular spot in the list.
*/
pageToken?: string;
/**
* This field contains the project Id for example: "projects/{PROJECT_ID}".
*/
parent?: string;
}
interface Params$Resource$Providers$Notes$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the note. Should be of the form
* "projects/{provider_id}/notes/{note_id}".
*/
name?: string;
/**
* The fields to update.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Note;
}
interface Params$Resource$Providers$Notes$Setiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SetIamPolicyRequest;
}
interface Params$Resource$Providers$Notes$Testiampermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
class Resource$Providers$Notes$Occurrences {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* containeranalysis.providers.notes.occurrences.list
* @desc Lists `Occurrences` referencing the specified `Note`. Use this
* method to get all occurrences referencing your `Note` across all your
* customer projects.
* @alias containeranalysis.providers.notes.occurrences.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The filter expression.
* @param {string} params.name The name field will contain the note name for example: "provider/{provider_id}/notes/{note_id}"
* @param {integer=} params.pageSize Number of notes to return in the list.
* @param {string=} params.pageToken Token to provide to skip to a particular spot in the list.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Providers$Notes$Occurrences$List, options?: MethodOptions): GaxiosPromise<Schema$ListNoteOccurrencesResponse>;
list(params: Params$Resource$Providers$Notes$Occurrences$List, options: MethodOptions | BodyResponseCallback<Schema$ListNoteOccurrencesResponse>, callback: BodyResponseCallback<Schema$ListNoteOccurrencesResponse>): void;
list(params: Params$Resource$Providers$Notes$Occurrences$List, callback: BodyResponseCallback<Schema$ListNoteOccurrencesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListNoteOccurrencesResponse>): void;
}
interface Params$Resource$Providers$Notes$Occurrences$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The filter expression.
*/
filter?: string;
/**
* The name field will contain the note name for example:
* "provider/{provider_id}/notes/{note_id}"
*/
name?: string;
/**
* Number of notes to return in the list.
*/
pageSize?: number;
/**
* Token to provide to skip to a particular spot in the list.
*/
pageToken?: string;
}
}