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
// This file is @generated by prost-build.
/// Step performed by the OS Config agent for configuring an `OSPolicyResource`
/// to its desired state.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OsPolicyResourceConfigStep {
/// Configuration step type.
#[prost(enumeration = "os_policy_resource_config_step::Type", tag = "1")]
pub r#type: i32,
/// Outcome of the configuration step.
#[prost(enumeration = "os_policy_resource_config_step::Outcome", tag = "2")]
pub outcome: i32,
/// An error message recorded during the execution of this step.
/// Only populated when outcome is FAILED.
#[prost(string, tag = "3")]
pub error_message: ::prost::alloc::string::String,
}
/// Nested message and enum types in `OSPolicyResourceConfigStep`.
pub mod os_policy_resource_config_step {
/// Supported configuration step types
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// Default value. This value is unused.
Unspecified = 0,
/// Validation to detect resource conflicts, schema errors, etc.
Validation = 1,
/// Check the current desired state status of the resource.
DesiredStateCheck = 2,
/// Enforce the desired state for a resource that is not in desired state.
DesiredStateEnforcement = 3,
/// Re-check desired state status for a resource after enforcement of all
/// resources in the current configuration run.
///
/// This step is used to determine the final desired state status for the
/// resource. It accounts for any resources that might have drifted from
/// their desired state due to side effects from configuring other resources
/// during the current configuration run.
DesiredStateCheckPostEnforcement = 4,
}
impl Type {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Type::Unspecified => "TYPE_UNSPECIFIED",
Type::Validation => "VALIDATION",
Type::DesiredStateCheck => "DESIRED_STATE_CHECK",
Type::DesiredStateEnforcement => "DESIRED_STATE_ENFORCEMENT",
Type::DesiredStateCheckPostEnforcement => {
"DESIRED_STATE_CHECK_POST_ENFORCEMENT"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"VALIDATION" => Some(Self::Validation),
"DESIRED_STATE_CHECK" => Some(Self::DesiredStateCheck),
"DESIRED_STATE_ENFORCEMENT" => Some(Self::DesiredStateEnforcement),
"DESIRED_STATE_CHECK_POST_ENFORCEMENT" => {
Some(Self::DesiredStateCheckPostEnforcement)
}
_ => None,
}
}
}
/// Supported outcomes for a configuration step.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Outcome {
/// Default value. This value is unused.
Unspecified = 0,
/// The step succeeded.
Succeeded = 1,
/// The step failed.
Failed = 2,
}
impl Outcome {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Outcome::Unspecified => "OUTCOME_UNSPECIFIED",
Outcome::Succeeded => "SUCCEEDED",
Outcome::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OUTCOME_UNSPECIFIED" => Some(Self::Unspecified),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
}
/// Compliance data for an OS policy resource.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OsPolicyResourceCompliance {
/// The id of the OS policy resource.
#[prost(string, tag = "1")]
pub os_policy_resource_id: ::prost::alloc::string::String,
/// Ordered list of configuration steps taken by the agent for the OS policy
/// resource.
#[prost(message, repeated, tag = "2")]
pub config_steps: ::prost::alloc::vec::Vec<OsPolicyResourceConfigStep>,
/// Compliance state of the OS policy resource.
#[prost(enumeration = "OsPolicyComplianceState", tag = "3")]
pub state: i32,
/// Resource specific output.
#[prost(oneof = "os_policy_resource_compliance::Output", tags = "4")]
pub output: ::core::option::Option<os_policy_resource_compliance::Output>,
}
/// Nested message and enum types in `OSPolicyResourceCompliance`.
pub mod os_policy_resource_compliance {
/// ExecResource specific output.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecResourceOutput {
/// Output from Enforcement phase output file (if run).
/// Output size is limited to 100K bytes.
#[prost(bytes = "bytes", tag = "2")]
pub enforcement_output: ::prost::bytes::Bytes,
}
/// Resource specific output.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Output {
/// ExecResource specific output.
#[prost(message, tag = "4")]
ExecResourceOutput(ExecResourceOutput),
}
}
/// Supported OSPolicy compliance states.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum OsPolicyComplianceState {
/// Default value. This value is unused.
Unspecified = 0,
/// Compliant state.
Compliant = 1,
/// Non-compliant state
NonCompliant = 2,
/// Unknown compliance state.
Unknown = 3,
/// No applicable OS policies were found for the instance.
/// This state is only applicable to the instance.
NoOsPoliciesApplicable = 4,
}
impl OsPolicyComplianceState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
OsPolicyComplianceState::Unspecified => {
"OS_POLICY_COMPLIANCE_STATE_UNSPECIFIED"
}
OsPolicyComplianceState::Compliant => "COMPLIANT",
OsPolicyComplianceState::NonCompliant => "NON_COMPLIANT",
OsPolicyComplianceState::Unknown => "UNKNOWN",
OsPolicyComplianceState::NoOsPoliciesApplicable => {
"NO_OS_POLICIES_APPLICABLE"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OS_POLICY_COMPLIANCE_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"COMPLIANT" => Some(Self::Compliant),
"NON_COMPLIANT" => Some(Self::NonCompliant),
"UNKNOWN" => Some(Self::Unknown),
"NO_OS_POLICIES_APPLICABLE" => Some(Self::NoOsPoliciesApplicable),
_ => None,
}
}
}
/// An OS policy defines the desired state configuration for an instance.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OsPolicy {}
/// Nested message and enum types in `OSPolicy`.
pub mod os_policy {
/// An OS policy resource is used to define the desired state configuration
/// and provides a specific functionality like installing/removing packages,
/// executing a script etc.
///
/// The system ensures that resources are always in their desired state by
/// taking necessary actions if they have drifted from their desired state.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Resource {
/// Required. The id of the resource with the following restrictions:
///
/// * Must contain only lowercase letters, numbers, and hyphens.
/// * Must start with a letter.
/// * Must be between 1-63 characters.
/// * Must end with a number or a letter.
/// * Must be unique within the OS policy.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// Resource type.
#[prost(oneof = "resource::ResourceType", tags = "2, 3, 4, 5")]
pub resource_type: ::core::option::Option<resource::ResourceType>,
}
/// Nested message and enum types in `Resource`.
pub mod resource {
/// A remote or local file.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct File {
/// Defaults to false. When false, files are subject to validations
/// based on the file type:
///
/// Remote: A checksum must be specified.
/// Cloud Storage: An object generation number must be specified.
#[prost(bool, tag = "4")]
pub allow_insecure: bool,
/// A specific type of file.
#[prost(oneof = "file::Type", tags = "1, 2, 3")]
pub r#type: ::core::option::Option<file::Type>,
}
/// Nested message and enum types in `File`.
pub mod file {
/// Specifies a file available via some URI.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Remote {
/// Required. URI from which to fetch the object. It should contain both the
/// protocol and path following the format `{protocol}://{location}`.
#[prost(string, tag = "1")]
pub uri: ::prost::alloc::string::String,
/// SHA256 checksum of the remote file.
#[prost(string, tag = "2")]
pub sha256_checksum: ::prost::alloc::string::String,
}
/// Specifies a file available as a Cloud Storage Object.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Gcs {
/// Required. Bucket of the Cloud Storage object.
#[prost(string, tag = "1")]
pub bucket: ::prost::alloc::string::String,
/// Required. Name of the Cloud Storage object.
#[prost(string, tag = "2")]
pub object: ::prost::alloc::string::String,
/// Generation number of the Cloud Storage object.
#[prost(int64, tag = "3")]
pub generation: i64,
}
/// A specific type of file.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Type {
/// A generic remote file.
#[prost(message, tag = "1")]
Remote(Remote),
/// A Cloud Storage object.
#[prost(message, tag = "2")]
Gcs(Gcs),
/// A local path to use.
#[prost(string, tag = "3")]
LocalPath(::prost::alloc::string::String),
}
}
/// A resource that manages a system package.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PackageResource {
/// Required. The desired state the agent should maintain for this package. The
/// default is to ensure the package is installed.
#[prost(enumeration = "package_resource::DesiredState", tag = "1")]
pub desired_state: i32,
/// A system package.
#[prost(
oneof = "package_resource::SystemPackage",
tags = "2, 3, 4, 5, 6, 7, 8"
)]
pub system_package: ::core::option::Option<package_resource::SystemPackage>,
}
/// Nested message and enum types in `PackageResource`.
pub mod package_resource {
/// A deb package file. dpkg packages only support INSTALLED state.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Deb {
/// Required. A deb package.
#[prost(message, optional, tag = "1")]
pub source: ::core::option::Option<super::File>,
/// Whether dependencies should also be installed.
/// install when false: `dpkg -i package`
/// install when true: `apt-get update && apt-get -y install
/// package.deb`
#[prost(bool, tag = "2")]
pub pull_deps: bool,
}
/// A package managed by APT.
/// install: `apt-get update && apt-get -y install \[name\]`
/// remove: `apt-get -y remove \[name\]`
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Apt {
/// Required. Package name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// An RPM package file. RPM packages only support INSTALLED state.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Rpm {
/// Required. An rpm package.
#[prost(message, optional, tag = "1")]
pub source: ::core::option::Option<super::File>,
/// Whether dependencies should also be installed.
/// install when false: `rpm --upgrade --replacepkgs package.rpm`
/// install when true: `yum -y install package.rpm` or
/// `zypper -y install package.rpm`
#[prost(bool, tag = "2")]
pub pull_deps: bool,
}
/// A package managed by YUM.
/// install: `yum -y install package`
/// remove: `yum -y remove package`
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Yum {
/// Required. Package name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// A package managed by Zypper.
/// install: `zypper -y install package`
/// remove: `zypper -y rm package`
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Zypper {
/// Required. Package name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// A package managed by GooGet.
/// install: `googet -noconfirm install package`
/// remove: `googet -noconfirm remove package`
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GooGet {
/// Required. Package name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// An MSI package. MSI packages only support INSTALLED state.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Msi {
/// Required. The MSI package.
#[prost(message, optional, tag = "1")]
pub source: ::core::option::Option<super::File>,
/// Additional properties to use during installation.
/// This should be in the format of Property=Setting.
/// Appended to the defaults of "ACTION=INSTALL
/// REBOOT=ReallySuppress".
#[prost(string, repeated, tag = "2")]
pub properties: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// The desired state that the OS Config agent maintains on the VM.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DesiredState {
/// Unspecified is invalid.
Unspecified = 0,
/// Ensure that the package is installed.
Installed = 1,
/// The agent ensures that the package is not installed and
/// uninstalls it if detected.
Removed = 2,
}
impl DesiredState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
DesiredState::Unspecified => "DESIRED_STATE_UNSPECIFIED",
DesiredState::Installed => "INSTALLED",
DesiredState::Removed => "REMOVED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DESIRED_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"INSTALLED" => Some(Self::Installed),
"REMOVED" => Some(Self::Removed),
_ => None,
}
}
}
/// A system package.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum SystemPackage {
/// A package managed by Apt.
#[prost(message, tag = "2")]
Apt(Apt),
/// A deb package file.
#[prost(message, tag = "3")]
Deb(Deb),
/// A package managed by YUM.
#[prost(message, tag = "4")]
Yum(Yum),
/// A package managed by Zypper.
#[prost(message, tag = "5")]
Zypper(Zypper),
/// An rpm package file.
#[prost(message, tag = "6")]
Rpm(Rpm),
/// A package managed by GooGet.
#[prost(message, tag = "7")]
Googet(GooGet),
/// An MSI package.
#[prost(message, tag = "8")]
Msi(Msi),
}
}
/// A resource that manages a package repository.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RepositoryResource {
/// A specific type of repository.
#[prost(oneof = "repository_resource::Repository", tags = "1, 2, 3, 4")]
pub repository: ::core::option::Option<repository_resource::Repository>,
}
/// Nested message and enum types in `RepositoryResource`.
pub mod repository_resource {
/// Represents a single apt package repository. These will be added to
/// a repo file that will be managed at
/// /etc/apt/sources.list.d/google_osconfig.list.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AptRepository {
/// Required. Type of archive files in this repository. The default behavior is
/// DEB.
#[prost(enumeration = "apt_repository::ArchiveType", tag = "1")]
pub archive_type: i32,
/// Required. URI for this repository.
#[prost(string, tag = "2")]
pub uri: ::prost::alloc::string::String,
/// Required. Distribution of this repository.
#[prost(string, tag = "3")]
pub distribution: ::prost::alloc::string::String,
/// Required. List of components for this repository. Must contain at least one
/// item.
#[prost(string, repeated, tag = "4")]
pub components: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// URI of the key file for this repository. The agent maintains a
/// keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg.
#[prost(string, tag = "5")]
pub gpg_key: ::prost::alloc::string::String,
}
/// Nested message and enum types in `AptRepository`.
pub mod apt_repository {
/// Type of archive.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ArchiveType {
/// Unspecified is invalid.
Unspecified = 0,
/// Deb indicates that the archive contains binary files.
Deb = 1,
/// Deb-src indicates that the archive contains source files.
DebSrc = 2,
}
impl ArchiveType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ArchiveType::Unspecified => "ARCHIVE_TYPE_UNSPECIFIED",
ArchiveType::Deb => "DEB",
ArchiveType::DebSrc => "DEB_SRC",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ARCHIVE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"DEB" => Some(Self::Deb),
"DEB_SRC" => Some(Self::DebSrc),
_ => None,
}
}
}
}
/// Represents a single yum package repository. These are added to a
/// repo file that is managed at
/// `/etc/yum.repos.d/google_osconfig.repo`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct YumRepository {
/// Required. A one word, unique name for this repository. This is the `repo
/// id` in the yum config file and also the `display_name` if
/// `display_name` is omitted. This id is also used as the unique
/// identifier when checking for resource conflicts.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The display name of the repository.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. The location of the repository directory.
#[prost(string, tag = "3")]
pub base_url: ::prost::alloc::string::String,
/// URIs of GPG keys.
#[prost(string, repeated, tag = "4")]
pub gpg_keys: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Represents a single zypper package repository. These are added to a
/// repo file that is managed at
/// `/etc/zypp/repos.d/google_osconfig.repo`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ZypperRepository {
/// Required. A one word, unique name for this repository. This is the `repo
/// id` in the zypper config file and also the `display_name` if
/// `display_name` is omitted. This id is also used as the unique
/// identifier when checking for GuestPolicy conflicts.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The display name of the repository.
#[prost(string, tag = "2")]
pub display_name: ::prost::alloc::string::String,
/// Required. The location of the repository directory.
#[prost(string, tag = "3")]
pub base_url: ::prost::alloc::string::String,
/// URIs of GPG keys.
#[prost(string, repeated, tag = "4")]
pub gpg_keys: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Represents a Goo package repository. These are added to a repo file
/// that is managed at
/// `C:/ProgramData/GooGet/repos/google_osconfig.repo`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GooRepository {
/// Required. The name of the repository.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The url of the repository.
#[prost(string, tag = "2")]
pub url: ::prost::alloc::string::String,
}
/// A specific type of repository.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Repository {
/// An Apt Repository.
#[prost(message, tag = "1")]
Apt(AptRepository),
/// A Yum Repository.
#[prost(message, tag = "2")]
Yum(YumRepository),
/// A Zypper Repository.
#[prost(message, tag = "3")]
Zypper(ZypperRepository),
/// A Goo Repository.
#[prost(message, tag = "4")]
Goo(GooRepository),
}
}
/// A resource that contains custom validation and enforcement steps.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecResource {
/// Required. What to run to validate this resource is in the desired state.
/// An exit code of 100 indicates "in desired state", and exit code of 101
/// indicates "not in desired state". Any other exit code indicates a
/// failure running validate.
#[prost(message, optional, tag = "1")]
pub validate: ::core::option::Option<exec_resource::Exec>,
/// What to run to bring this resource into the desired state.
/// A exit code of 100 indicates "success", any other exit code idicates a
/// failure running enforce.
#[prost(message, optional, tag = "2")]
pub enforce: ::core::option::Option<exec_resource::Exec>,
}
/// Nested message and enum types in `ExecResource`.
pub mod exec_resource {
/// A file or script to execute.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Exec {
/// Optional arguments to pass to the source during execution.
#[prost(string, repeated, tag = "3")]
pub args: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Required. The script interpreter to use.
#[prost(enumeration = "exec::Interpreter", tag = "4")]
pub interpreter: i32,
/// Only recorded for enforce Exec.
/// Path to an output file (that is created by this Exec) whose
/// content will be recorded in OSPolicyResourceCompliance after a
/// successful run. Absence or failure to read this file will result in
/// this ExecResource being non-compliant. Output file size is limited to
/// 100K bytes.
#[prost(string, tag = "5")]
pub output_file_path: ::prost::alloc::string::String,
/// What to execute.
#[prost(oneof = "exec::Source", tags = "1, 2")]
pub source: ::core::option::Option<exec::Source>,
}
/// Nested message and enum types in `Exec`.
pub mod exec {
/// The interpreter to use.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Interpreter {
/// Invalid value, the request will return validation error.
Unspecified = 0,
/// If no interpreter is specified the
/// source will be executed directly, which will likely only
/// succeed for executables and scripts with shebang lines.
/// [Wikipedia
/// shebang](<https://en.wikipedia.org/wiki/Shebang_(Unix>)).
None = 1,
/// Indicates that the script will be run with /bin/sh on Linux and
/// cmd.exe on windows.
Shell = 2,
/// Indicates that the script will be run with powershell.
Powershell = 3,
}
impl Interpreter {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Interpreter::Unspecified => "INTERPRETER_UNSPECIFIED",
Interpreter::None => "NONE",
Interpreter::Shell => "SHELL",
Interpreter::Powershell => "POWERSHELL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INTERPRETER_UNSPECIFIED" => Some(Self::Unspecified),
"NONE" => Some(Self::None),
"SHELL" => Some(Self::Shell),
"POWERSHELL" => Some(Self::Powershell),
_ => None,
}
}
}
/// What to execute.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// A remote or local file.
#[prost(message, tag = "1")]
File(super::super::File),
/// An inline script.
#[prost(string, tag = "2")]
Script(::prost::alloc::string::String),
}
}
}
/// A resource that manages the state of a file.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FileResource {
/// Required. The absolute path of the file.
#[prost(string, tag = "3")]
pub path: ::prost::alloc::string::String,
/// Required. Desired state of the file.
#[prost(enumeration = "file_resource::DesiredState", tag = "4")]
pub state: i32,
/// Consists of three octal digits which represent, in
/// order, the permissions of the owner, group, and other users for the
/// file (similarly to the numeric mode used in the linux chmod
/// utility). Each digit represents a three bit number with the 4 bit
/// corresponding to the read permissions, the 2 bit corresponds to the
/// write bit, and the one bit corresponds to the execute permission.
/// Default behavior is 755.
///
/// Below are some examples of permissions and their associated values:
/// read, write, and execute: 7
/// read and execute: 5
/// read and write: 6
/// read only: 4
#[prost(string, tag = "5")]
pub permissions: ::prost::alloc::string::String,
/// The source for the contents of the file.
#[prost(oneof = "file_resource::Source", tags = "1, 2")]
pub source: ::core::option::Option<file_resource::Source>,
}
/// Nested message and enum types in `FileResource`.
pub mod file_resource {
/// Desired state of the file.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum DesiredState {
/// Unspecified is invalid.
Unspecified = 0,
/// Ensure file at path is present.
Present = 1,
/// Ensure file at path is absent.
Absent = 2,
/// Ensure the contents of the file at path matches. If the file does
/// not exist it will be created.
ContentsMatch = 3,
}
impl DesiredState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
DesiredState::Unspecified => "DESIRED_STATE_UNSPECIFIED",
DesiredState::Present => "PRESENT",
DesiredState::Absent => "ABSENT",
DesiredState::ContentsMatch => "CONTENTS_MATCH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DESIRED_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"PRESENT" => Some(Self::Present),
"ABSENT" => Some(Self::Absent),
"CONTENTS_MATCH" => Some(Self::ContentsMatch),
_ => None,
}
}
}
/// The source for the contents of the file.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Source {
/// A remote or local source.
#[prost(message, tag = "1")]
File(super::File),
/// A a file with this content.
#[prost(string, tag = "2")]
Content(::prost::alloc::string::String),
}
}
/// Resource type.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ResourceType {
/// Package resource
#[prost(message, tag = "2")]
Pkg(PackageResource),
/// Package repository resource
#[prost(message, tag = "3")]
Repository(RepositoryResource),
/// Exec resource
#[prost(message, tag = "4")]
Exec(ExecResource),
/// File resource
#[prost(message, tag = "5")]
File(FileResource),
}
}
/// Policy mode
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Mode {
/// Invalid mode
Unspecified = 0,
/// This mode checks if the configuration resources in the policy are in
/// their desired state. No actions are performed if they are not in the
/// desired state. This mode is used for reporting purposes.
Validation = 1,
/// This mode checks if the configuration resources in the policy are in
/// their desired state, and if not, enforces the desired state.
Enforcement = 2,
}
impl Mode {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Mode::Unspecified => "MODE_UNSPECIFIED",
Mode::Validation => "VALIDATION",
Mode::Enforcement => "ENFORCEMENT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MODE_UNSPECIFIED" => Some(Self::Unspecified),
"VALIDATION" => Some(Self::Validation),
"ENFORCEMENT" => Some(Self::Enforcement),
_ => None,
}
}
}
}
/// Patch configuration specifications. Contains details on how to
/// apply patches to a VM instance.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PatchConfig {
/// Post-patch reboot settings.
#[prost(enumeration = "patch_config::RebootConfig", tag = "1")]
pub reboot_config: i32,
/// Retry strategy can be defined to have the agent retry patching
/// during the window if patching fails. If omitted, the agent will use its
/// default retry strategy.
#[prost(message, optional, tag = "2")]
pub retry_strategy: ::core::option::Option<RetryStrategy>,
/// Apt update settings. Use this override the default apt patch rules.
#[prost(message, optional, tag = "3")]
pub apt: ::core::option::Option<AptSettings>,
/// Yum update settings. Use this override the default yum patch rules.
#[prost(message, optional, tag = "4")]
pub yum: ::core::option::Option<YumSettings>,
/// Goo update settings. Use this override the default goo patch rules.
#[prost(message, optional, tag = "5")]
pub goo: ::core::option::Option<GooSettings>,
/// Zypper update settings. Use this override the default zypper patch rules.
#[prost(message, optional, tag = "6")]
pub zypper: ::core::option::Option<ZypperSettings>,
/// Windows update settings. Use this override the default windows patch rules.
#[prost(message, optional, tag = "7")]
pub windows_update: ::core::option::Option<WindowsUpdateSettings>,
/// The ExecStep to run before the patch update.
#[prost(message, optional, tag = "8")]
pub pre_step: ::core::option::Option<ExecStep>,
/// The ExecStep to run after the patch update.
#[prost(message, optional, tag = "9")]
pub post_step: ::core::option::Option<ExecStep>,
/// Allows the patch job to run on Managed instance groups (MIGs).
#[prost(bool, tag = "10")]
pub mig_instances_allowed: bool,
}
/// Nested message and enum types in `PatchConfig`.
pub mod patch_config {
/// Post-patch reboot settings.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum RebootConfig {
/// The default behavior is DEFAULT.
Unspecified = 0,
/// The agent decides if a reboot is necessary by checking
/// signals such as registry keys on Windows or `/var/run/reboot-required` on
/// APT based systems. On RPM based systems, a set of core system package
/// install times are compared with system boot time.
Default = 1,
/// Always reboot the machine after the update completes.
Always = 2,
/// Never reboot the machine after the update completes.
Never = 3,
}
impl RebootConfig {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
RebootConfig::Unspecified => "REBOOT_CONFIG_UNSPECIFIED",
RebootConfig::Default => "DEFAULT",
RebootConfig::Always => "ALWAYS",
RebootConfig::Never => "NEVER",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"REBOOT_CONFIG_UNSPECIFIED" => Some(Self::Unspecified),
"DEFAULT" => Some(Self::Default),
"ALWAYS" => Some(Self::Always),
"NEVER" => Some(Self::Never),
_ => None,
}
}
}
}
/// Apt patching will be performed by executing `apt-get update && apt-get
/// upgrade`. Additional options can be set to control how this is executed.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AptSettings {
/// By changing the type to DIST, the patching will be performed
/// using `apt-get dist-upgrade` instead.
#[prost(enumeration = "apt_settings::Type", tag = "1")]
pub r#type: i32,
/// List of packages to exclude from update.
#[prost(string, repeated, tag = "2")]
pub excludes: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// An exclusive list of packages to be updated. These are the only packages
/// that will be updated. If these packages are not installed, they will be
/// ignored. This field cannot be specified with any other patch configuration
/// fields.
#[prost(string, repeated, tag = "3")]
pub exclusive_packages: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Nested message and enum types in `AptSettings`.
pub mod apt_settings {
/// Apt patch type.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Type {
/// By default, upgrade will be performed.
Unspecified = 0,
/// Runs `apt-get dist-upgrade`.
Dist = 1,
/// Runs `apt-get upgrade`.
Upgrade = 2,
}
impl Type {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Type::Unspecified => "TYPE_UNSPECIFIED",
Type::Dist => "DIST",
Type::Upgrade => "UPGRADE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"DIST" => Some(Self::Dist),
"UPGRADE" => Some(Self::Upgrade),
_ => None,
}
}
}
}
/// Yum patching will be performed by executing `yum update`. Additional options
/// can be set to control how this is executed.
///
/// Note that not all settings are supported on all platforms.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct YumSettings {
/// Adds the `--security` flag to `yum update`. Not supported on
/// all platforms.
#[prost(bool, tag = "1")]
pub security: bool,
/// Will cause patch to run `yum update-minimal` instead.
#[prost(bool, tag = "2")]
pub minimal: bool,
/// List of packages to exclude from update. These packages will be excluded by
/// using the yum `--exclude` flag.
#[prost(string, repeated, tag = "3")]
pub excludes: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// An exclusive list of packages to be updated. These are the only packages
/// that will be updated. If these packages are not installed, they will be
/// ignored. This field must not be specified with any other patch
/// configuration fields.
#[prost(string, repeated, tag = "4")]
pub exclusive_packages: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Googet patching is performed by running `googet update`.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GooSettings {}
/// Zypper patching is performed by running `zypper patch`.
/// See also <https://en.opensuse.org/SDB:Zypper_manual.>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ZypperSettings {
/// Adds the `--with-optional` flag to `zypper patch`.
#[prost(bool, tag = "1")]
pub with_optional: bool,
/// Adds the `--with-update` flag, to `zypper patch`.
#[prost(bool, tag = "2")]
pub with_update: bool,
/// Install only patches with these categories.
/// Common categories include security, recommended, and feature.
#[prost(string, repeated, tag = "3")]
pub categories: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Install only patches with these severities.
/// Common severities include critical, important, moderate, and low.
#[prost(string, repeated, tag = "4")]
pub severities: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// List of patches to exclude from update.
#[prost(string, repeated, tag = "5")]
pub excludes: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// An exclusive list of patches to be updated. These are the only patches
/// that will be installed using 'zypper patch patch:<patch_name>' command.
/// This field must not be used with any other patch configuration fields.
#[prost(string, repeated, tag = "6")]
pub exclusive_patches: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Windows patching is performed using the Windows Update Agent.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WindowsUpdateSettings {
/// Only apply updates of these windows update classifications. If empty, all
/// updates will be applied.
#[prost(
enumeration = "windows_update_settings::Classification",
repeated,
tag = "1"
)]
pub classifications: ::prost::alloc::vec::Vec<i32>,
/// List of KBs to exclude from update.
#[prost(string, repeated, tag = "2")]
pub excludes: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// An exclusive list of kbs to be updated. These are the only patches
/// that will be updated. This field must not be used with other
/// patch configurations.
#[prost(string, repeated, tag = "3")]
pub exclusive_patches: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Nested message and enum types in `WindowsUpdateSettings`.
pub mod windows_update_settings {
/// Microsoft Windows update classifications as defined in
/// \[1\]
/// <https://support.microsoft.com/en-us/help/824684/description-of-the-standard-terminology-that-is-used-to-describe-micro>
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Classification {
/// Invalid. If classifications are included, they must be specified.
Unspecified = 0,
/// "A widely released fix for a specific problem that addresses a critical,
/// non-security-related bug." \[1\]
Critical = 1,
/// "A widely released fix for a product-specific, security-related
/// vulnerability. Security vulnerabilities are rated by their severity. The
/// severity rating is indicated in the Microsoft security bulletin as
/// critical, important, moderate, or low." \[1\]
Security = 2,
/// "A widely released and frequent software update that contains additions
/// to a product’s definition database. Definition databases are often used
/// to detect objects that have specific attributes, such as malicious code,
/// phishing websites, or junk mail." \[1\]
Definition = 3,
/// "Software that controls the input and output of a device." \[1\]
Driver = 4,
/// "New product functionality that is first distributed outside the context
/// of a product release and that is typically included in the next full
/// product release." \[1\]
FeaturePack = 5,
/// "A tested, cumulative set of all hotfixes, security updates, critical
/// updates, and updates. Additionally, service packs may contain additional
/// fixes for problems that are found internally since the release of the
/// product. Service packs my also contain a limited number of
/// customer-requested design changes or features." \[1\]
ServicePack = 6,
/// "A utility or feature that helps complete a task or set of tasks." \[1\]
Tool = 7,
/// "A tested, cumulative set of hotfixes, security updates, critical
/// updates, and updates that are packaged together for easy deployment. A
/// rollup generally targets a specific area, such as security, or a
/// component of a product, such as Internet Information Services (IIS)." \[1\]
UpdateRollup = 8,
/// "A widely released fix for a specific problem. An update addresses a
/// noncritical, non-security-related bug." \[1\]
Update = 9,
}
impl Classification {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Classification::Unspecified => "CLASSIFICATION_UNSPECIFIED",
Classification::Critical => "CRITICAL",
Classification::Security => "SECURITY",
Classification::Definition => "DEFINITION",
Classification::Driver => "DRIVER",
Classification::FeaturePack => "FEATURE_PACK",
Classification::ServicePack => "SERVICE_PACK",
Classification::Tool => "TOOL",
Classification::UpdateRollup => "UPDATE_ROLLUP",
Classification::Update => "UPDATE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"CLASSIFICATION_UNSPECIFIED" => Some(Self::Unspecified),
"CRITICAL" => Some(Self::Critical),
"SECURITY" => Some(Self::Security),
"DEFINITION" => Some(Self::Definition),
"DRIVER" => Some(Self::Driver),
"FEATURE_PACK" => Some(Self::FeaturePack),
"SERVICE_PACK" => Some(Self::ServicePack),
"TOOL" => Some(Self::Tool),
"UPDATE_ROLLUP" => Some(Self::UpdateRollup),
"UPDATE" => Some(Self::Update),
_ => None,
}
}
}
}
/// The strategy for retrying failed patches during the patch window.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RetryStrategy {
/// If true, the agent will continue to try and patch until the window has
/// ended.
#[prost(bool, tag = "1")]
pub enabled: bool,
}
/// A step that runs an executable for a PatchJob.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecStep {
/// The ExecStepConfig for all Linux VMs targeted by the PatchJob.
#[prost(message, optional, tag = "1")]
pub linux_exec_step_config: ::core::option::Option<ExecStepConfig>,
/// The ExecStepConfig for all Windows VMs targeted by the PatchJob.
#[prost(message, optional, tag = "2")]
pub windows_exec_step_config: ::core::option::Option<ExecStepConfig>,
}
/// Common configurations for an ExecStep.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecStepConfig {
/// Defaults to \[0\]. A list of possible return values that the
/// execution can return to indicate a success.
#[prost(int32, repeated, tag = "3")]
pub allowed_success_codes: ::prost::alloc::vec::Vec<i32>,
/// The script interpreter to use to run the script. If no interpreter is
/// specified the script will be executed directly, which will likely
/// only succeed for scripts with shebang lines.
/// [Wikipedia shebang](<https://en.wikipedia.org/wiki/Shebang_(Unix>)).
#[prost(enumeration = "exec_step_config::Interpreter", tag = "4")]
pub interpreter: i32,
/// Location of the executable.
#[prost(oneof = "exec_step_config::Executable", tags = "1, 2")]
pub executable: ::core::option::Option<exec_step_config::Executable>,
}
/// Nested message and enum types in `ExecStepConfig`.
pub mod exec_step_config {
/// The interpreter used to execute the a file.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Interpreter {
/// Deprecated, defaults to NONE for compatibility reasons.
Unspecified = 0,
/// Invalid for a Windows ExecStepConfig. For a Linux ExecStepConfig, the
/// interpreter will be parsed from the shebang line of the script if
/// unspecified.
None = 3,
/// Indicates that the script will be run with /bin/sh on Linux and cmd
/// on windows.
Shell = 1,
/// Indicates that the file will be run with PowerShell.
Powershell = 2,
}
impl Interpreter {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Interpreter::Unspecified => "INTERPRETER_UNSPECIFIED",
Interpreter::None => "NONE",
Interpreter::Shell => "SHELL",
Interpreter::Powershell => "POWERSHELL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INTERPRETER_UNSPECIFIED" => Some(Self::Unspecified),
"NONE" => Some(Self::None),
"SHELL" => Some(Self::Shell),
"POWERSHELL" => Some(Self::Powershell),
_ => None,
}
}
}
/// Location of the executable.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Executable {
/// An absolute path to the executable on the VM.
#[prost(string, tag = "1")]
LocalPath(::prost::alloc::string::String),
/// A GCS object containing the executable.
#[prost(message, tag = "2")]
GcsObject(super::GcsObject),
}
}
/// GCS object representation.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GcsObject {
/// Bucket of the GCS object.
#[prost(string, tag = "1")]
pub bucket: ::prost::alloc::string::String,
/// Name of the GCS object.
#[prost(string, tag = "2")]
pub object: ::prost::alloc::string::String,
/// Generation number of the GCS object. This is used to ensure that the
/// ExecStep specified by this PatchJob does not change.
#[prost(int64, tag = "3")]
pub generation_number: i64,
}
/// A unit of work to be performed by the agent.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Task {
/// Unique task id.
#[prost(string, tag = "1")]
pub task_id: ::prost::alloc::string::String,
/// The type of task to perform.
///
/// Task details must include the appropriate message based on this enum as
/// specified below:
/// APPLY_PATCHES = ApplyPatchesTask
/// EXEC_STEP = ExecStepTask
/// APPLY_CONFIG_TASK = ApplyConfigTask
#[prost(enumeration = "TaskType", tag = "2")]
pub task_type: i32,
/// Current directive to the agent.
#[prost(enumeration = "TaskDirective", tag = "3")]
pub task_directive: i32,
/// Labels describing the task. Used for logging by the agent.
#[prost(btree_map = "string, string", tag = "6")]
pub service_labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Specific details about the current task to perform.
#[prost(oneof = "task::TaskDetails", tags = "4, 5, 7")]
pub task_details: ::core::option::Option<task::TaskDetails>,
}
/// Nested message and enum types in `Task`.
pub mod task {
/// Specific details about the current task to perform.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TaskDetails {
/// Details about the apply patches task to perform.
#[prost(message, tag = "4")]
ApplyPatchesTask(super::ApplyPatchesTask),
/// Details about the exec step task to perform.
#[prost(message, tag = "5")]
ExecStepTask(super::ExecStepTask),
/// Details about the apply config step task to perform.
#[prost(message, tag = "7")]
ApplyConfigTask(super::ApplyConfigTask),
}
}
/// Message which instructs agent to apply patches.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ApplyPatchesTask {
/// Specific information about how patches should be applied.
#[prost(message, optional, tag = "1")]
pub patch_config: ::core::option::Option<PatchConfig>,
/// If true, the agent will report its status as it goes through the motions
/// but won't actually run any updates or perform any reboots.
#[prost(bool, tag = "3")]
pub dry_run: bool,
}
/// Information reported from the agent about applying patches execution.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ApplyPatchesTaskProgress {
/// Required. The current state of this patch execution.
#[prost(enumeration = "apply_patches_task_progress::State", tag = "1")]
pub state: i32,
}
/// Nested message and enum types in `ApplyPatchesTaskProgress`.
pub mod apply_patches_task_progress {
/// The intermediate states of applying patches.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified is invalid.
Unspecified = 0,
/// The agent has started the patch task.
Started = 4,
/// The agent is currently downloading patches.
DownloadingPatches = 1,
/// The agent is currently applying patches.
ApplyingPatches = 2,
/// The agent is currently rebooting the instance.
Rebooting = 3,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Started => "STARTED",
State::DownloadingPatches => "DOWNLOADING_PATCHES",
State::ApplyingPatches => "APPLYING_PATCHES",
State::Rebooting => "REBOOTING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"STARTED" => Some(Self::Started),
"DOWNLOADING_PATCHES" => Some(Self::DownloadingPatches),
"APPLYING_PATCHES" => Some(Self::ApplyingPatches),
"REBOOTING" => Some(Self::Rebooting),
_ => None,
}
}
}
}
/// Information reported from the agent about applying patches execution.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ApplyPatchesTaskOutput {
/// Required. The final state of this task.
#[prost(enumeration = "apply_patches_task_output::State", tag = "1")]
pub state: i32,
}
/// Nested message and enum types in `ApplyPatchesTaskOutput`.
pub mod apply_patches_task_output {
/// The final states of applying patches.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified is invalid.
Unspecified = 0,
/// Applying patches completed successfully.
Succeeded = 1,
/// Applying patches completed successfully, but a reboot is required.
SucceededRebootRequired = 2,
/// Applying patches failed.
Failed = 3,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Succeeded => "SUCCEEDED",
State::SucceededRebootRequired => "SUCCEEDED_REBOOT_REQUIRED",
State::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"SUCCEEDED" => Some(Self::Succeeded),
"SUCCEEDED_REBOOT_REQUIRED" => Some(Self::SucceededRebootRequired),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
}
/// Message which instructs agent to execute the following command.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecStepTask {
/// Details of the exec step to run.
#[prost(message, optional, tag = "1")]
pub exec_step: ::core::option::Option<ExecStep>,
}
/// Information reported from the agent about the exec step execution.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecStepTaskProgress {
/// Required. The current state of this exec step.
#[prost(enumeration = "exec_step_task_progress::State", tag = "1")]
pub state: i32,
}
/// Nested message and enum types in `ExecStepTaskProgress`.
pub mod exec_step_task_progress {
/// The intermediate states of exec steps.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified is invalid.
Unspecified = 0,
/// The agent has started the exec step task.
Started = 1,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Started => "STARTED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"STARTED" => Some(Self::Started),
_ => None,
}
}
}
}
/// Information reported from the agent about the exec step execution.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExecStepTaskOutput {
/// Required. The final state of the exec step.
#[prost(enumeration = "exec_step_task_output::State", tag = "1")]
pub state: i32,
/// Required. The exit code received from the script which ran as part of the exec step.
#[prost(int32, tag = "2")]
pub exit_code: i32,
}
/// Nested message and enum types in `ExecStepTaskOutput`.
pub mod exec_step_task_output {
/// The final states of exec steps.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified is invalid.
Unspecified = 0,
/// The exec step completed normally.
Completed = 1,
/// The exec step was terminated because it took too long.
TimedOut = 2,
/// The exec step task was cancelled before it started.
Cancelled = 3,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Completed => "COMPLETED",
State::TimedOut => "TIMED_OUT",
State::Cancelled => "CANCELLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"COMPLETED" => Some(Self::Completed),
"TIMED_OUT" => Some(Self::TimedOut),
"CANCELLED" => Some(Self::Cancelled),
_ => None,
}
}
}
}
/// Message which instructs OS Config agent to apply the desired state
/// configuration.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ApplyConfigTask {
/// List of os policies to be applied for the instance.
#[prost(message, repeated, tag = "1")]
pub os_policies: ::prost::alloc::vec::Vec<apply_config_task::OsPolicy>,
}
/// Nested message and enum types in `ApplyConfigTask`.
pub mod apply_config_task {
/// Message representing an OS policy.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OsPolicy {
/// User provided policy id.
/// Used for reporting and logging by the agent.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The policy mode
#[prost(enumeration = "super::os_policy::Mode", tag = "2")]
pub mode: i32,
/// Reference to the `OSPolicyAssignment` API resource that this `OSPolicy`
/// belongs to.
/// Format:
/// projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}
/// Used for reporting and logging by the agent.
#[prost(string, tag = "3")]
pub os_policy_assignment: ::prost::alloc::string::String,
/// List of resources associated with the policy to be set to their
/// desired state.
#[prost(message, repeated, tag = "4")]
pub resources: ::prost::alloc::vec::Vec<super::os_policy::Resource>,
}
}
/// Information reported from the agent regarding the progress of the task of
/// applying desired state configuration.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ApplyConfigTaskProgress {
/// The current state of this task.
#[prost(enumeration = "apply_config_task_progress::State", tag = "1")]
pub state: i32,
}
/// Nested message and enum types in `ApplyConfigTaskProgress`.
pub mod apply_config_task_progress {
/// The intermediate states of apply config task.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Invalid state
Unspecified = 0,
/// The agent has started the task.
Started = 1,
/// The agent is in the process of applying the configuration.
ApplyingConfig = 2,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Started => "STARTED",
State::ApplyingConfig => "APPLYING_CONFIG",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"STARTED" => Some(Self::Started),
"APPLYING_CONFIG" => Some(Self::ApplyingConfig),
_ => None,
}
}
}
}
/// Information reported from the agent regarding the output of the task of
/// applying desired state configuration.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ApplyConfigTaskOutput {
/// Required. The final state of this task.
#[prost(enumeration = "apply_config_task_output::State", tag = "1")]
pub state: i32,
/// Results of applying desired state config for the OS policies.
#[prost(message, repeated, tag = "2")]
pub os_policy_results: ::prost::alloc::vec::Vec<
apply_config_task_output::OsPolicyResult,
>,
}
/// Nested message and enum types in `ApplyConfigTaskOutput`.
pub mod apply_config_task_output {
/// Result of applying desired state config for an OS policy.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OsPolicyResult {
/// The OS policy id
#[prost(string, tag = "1")]
pub os_policy_id: ::prost::alloc::string::String,
/// Reference to the `OSPolicyAssignment` API resource that this `OSPolicy`
/// belongs to.
/// Format:
/// projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}
/// Used for reporting and logging by the agent.
#[prost(string, tag = "2")]
pub os_policy_assignment: ::prost::alloc::string::String,
/// Results of applying desired state config for the OS policy resources.
#[prost(message, repeated, tag = "3")]
pub os_policy_resource_compliances: ::prost::alloc::vec::Vec<
super::OsPolicyResourceCompliance,
>,
}
/// The final state of this task.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified is invalid.
Unspecified = 0,
/// The apply config task completed successfully.
Succeeded = 1,
/// The apply config task failed.
Failed = 2,
/// The apply config task was cancelled.
Cancelled = 3,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Succeeded => "SUCCEEDED",
State::Failed => "FAILED",
State::Cancelled => "CANCELLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
"CANCELLED" => Some(Self::Cancelled),
_ => None,
}
}
}
}
/// Specifies the current agent behavior.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum TaskDirective {
/// Unspecified is invalid.
Unspecified = 0,
/// The task should continue to progress.
Continue = 1,
/// Task should not be started, or if already in progress, should stop
/// at first safe stopping point. Task should be considered done and will
/// never repeat.
Stop = 2,
}
impl TaskDirective {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
TaskDirective::Unspecified => "TASK_DIRECTIVE_UNSPECIFIED",
TaskDirective::Continue => "CONTINUE",
TaskDirective::Stop => "STOP",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TASK_DIRECTIVE_UNSPECIFIED" => Some(Self::Unspecified),
"CONTINUE" => Some(Self::Continue),
"STOP" => Some(Self::Stop),
_ => None,
}
}
}
/// Specifies the type of task to perform.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum TaskType {
/// Unspecified is invalid.
Unspecified = 0,
/// The apply patches task.
ApplyPatches = 1,
/// The exec step task.
ExecStepTask = 2,
/// The apply config task
ApplyConfigTask = 3,
}
impl TaskType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
TaskType::Unspecified => "TASK_TYPE_UNSPECIFIED",
TaskType::ApplyPatches => "APPLY_PATCHES",
TaskType::ExecStepTask => "EXEC_STEP_TASK",
TaskType::ApplyConfigTask => "APPLY_CONFIG_TASK",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TASK_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"APPLY_PATCHES" => Some(Self::ApplyPatches),
"EXEC_STEP_TASK" => Some(Self::ExecStepTask),
"APPLY_CONFIG_TASK" => Some(Self::ApplyConfigTask),
_ => None,
}
}
}
/// The inventory details of a VM.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Inventory {
/// Base level operating system information for the VM.
#[prost(message, optional, tag = "1")]
pub os_info: ::core::option::Option<inventory::OsInfo>,
/// A list of installed packages currently on the VM.
#[prost(message, repeated, tag = "2")]
pub installed_packages: ::prost::alloc::vec::Vec<inventory::SoftwarePackage>,
/// A list of software updates available for the VM as reported by the update
/// managers.
#[prost(message, repeated, tag = "3")]
pub available_packages: ::prost::alloc::vec::Vec<inventory::SoftwarePackage>,
}
/// Nested message and enum types in `Inventory`.
pub mod inventory {
/// Operating system information for the VM.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OsInfo {
/// The VM hostname.
#[prost(string, tag = "1")]
pub hostname: ::prost::alloc::string::String,
/// The operating system long name.
/// For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019
/// Datacenter'.
#[prost(string, tag = "2")]
pub long_name: ::prost::alloc::string::String,
/// The operating system short name.
/// For example, 'windows' or 'debian'.
#[prost(string, tag = "3")]
pub short_name: ::prost::alloc::string::String,
/// The version of the operating system.
#[prost(string, tag = "4")]
pub version: ::prost::alloc::string::String,
/// The system architecture of the operating system.
#[prost(string, tag = "5")]
pub architecture: ::prost::alloc::string::String,
/// The kernel version of the operating system.
#[prost(string, tag = "6")]
pub kernel_version: ::prost::alloc::string::String,
/// The kernel release of the operating system.
#[prost(string, tag = "7")]
pub kernel_release: ::prost::alloc::string::String,
/// The current version of the OS Config agent running on the VM.
#[prost(string, tag = "8")]
pub osconfig_agent_version: ::prost::alloc::string::String,
}
/// Software package information of the operating system.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SoftwarePackage {
/// Information about the different types of software packages.
#[prost(oneof = "software_package::Details", tags = "1, 2, 3, 4, 5, 6, 7, 8, 9")]
pub details: ::core::option::Option<software_package::Details>,
}
/// Nested message and enum types in `SoftwarePackage`.
pub mod software_package {
/// Information about the different types of software packages.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Details {
/// Yum package info.
/// For details about the yum package manager, see
/// <https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum.>
#[prost(message, tag = "1")]
YumPackage(super::VersionedPackage),
/// Details of an APT package.
/// For details about the apt package manager, see
/// <https://wiki.debian.org/Apt.>
#[prost(message, tag = "2")]
AptPackage(super::VersionedPackage),
/// Details of a Zypper package.
/// For details about the Zypper package manager, see
/// <https://en.opensuse.org/SDB:Zypper_manual.>
#[prost(message, tag = "3")]
ZypperPackage(super::VersionedPackage),
/// Details of a Googet package.
/// For details about the googet package manager, see
/// <https://github.com/google/googet.>
#[prost(message, tag = "4")]
GoogetPackage(super::VersionedPackage),
/// Details of a Zypper patch.
/// For details about the Zypper package manager, see
/// <https://en.opensuse.org/SDB:Zypper_manual.>
#[prost(message, tag = "5")]
ZypperPatch(super::ZypperPatch),
/// Details of a Windows Update package.
/// See <https://docs.microsoft.com/en-us/windows/win32/api/_wua/> for
/// information about Windows Update.
#[prost(message, tag = "6")]
WuaPackage(super::WindowsUpdatePackage),
/// Details of a Windows Quick Fix engineering package.
/// See
/// <https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering>
/// for info in Windows Quick Fix Engineering.
#[prost(message, tag = "7")]
QfePackage(super::WindowsQuickFixEngineeringPackage),
/// Details of a COS package.
#[prost(message, tag = "8")]
CosPackage(super::VersionedPackage),
/// Details of Windows Application.
#[prost(message, tag = "9")]
WindowsApplication(super::WindowsApplication),
}
}
/// Information related to the a standard versioned package. This includes
/// package info for APT, Yum, Zypper, and Googet package managers.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct VersionedPackage {
/// The name of the package.
#[prost(string, tag = "1")]
pub package_name: ::prost::alloc::string::String,
/// The system architecture this package is intended for.
#[prost(string, tag = "2")]
pub architecture: ::prost::alloc::string::String,
/// The version of the package.
#[prost(string, tag = "3")]
pub version: ::prost::alloc::string::String,
}
/// Details related to a Zypper Patch.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ZypperPatch {
/// The name of the patch.
#[prost(string, tag = "1")]
pub patch_name: ::prost::alloc::string::String,
/// The category of the patch.
#[prost(string, tag = "2")]
pub category: ::prost::alloc::string::String,
/// The severity specified for this patch
#[prost(string, tag = "3")]
pub severity: ::prost::alloc::string::String,
/// Any summary information provided about this patch.
#[prost(string, tag = "4")]
pub summary: ::prost::alloc::string::String,
}
/// Details related to a Windows Update package.
/// Field data and names are taken from Windows Update API IUpdate Interface:
/// <https://docs.microsoft.com/en-us/windows/win32/api/_wua/>
/// Descriptive fields like title, and description are localized based on
/// the locale of the VM being updated.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WindowsUpdatePackage {
/// The localized title of the update package.
#[prost(string, tag = "1")]
pub title: ::prost::alloc::string::String,
/// The localized description of the update package.
#[prost(string, tag = "2")]
pub description: ::prost::alloc::string::String,
/// The categories that are associated with this update package.
#[prost(message, repeated, tag = "3")]
pub categories: ::prost::alloc::vec::Vec<
windows_update_package::WindowsUpdateCategory,
>,
/// A collection of Microsoft Knowledge Base article IDs that are associated
/// with the update package.
#[prost(string, repeated, tag = "4")]
pub kb_article_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// A hyperlink to the language-specific support information for the update.
#[prost(string, tag = "5")]
pub support_url: ::prost::alloc::string::String,
/// A collection of URLs that provide more information about the update
/// package.
#[prost(string, repeated, tag = "6")]
pub more_info_urls: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Gets the identifier of an update package. Stays the same across
/// revisions.
#[prost(string, tag = "7")]
pub update_id: ::prost::alloc::string::String,
/// The revision number of this update package.
#[prost(int32, tag = "8")]
pub revision_number: i32,
/// The last published date of the update, in (UTC) date and time.
#[prost(message, optional, tag = "9")]
pub last_deployment_change_time: ::core::option::Option<
::prost_types::Timestamp,
>,
}
/// Nested message and enum types in `WindowsUpdatePackage`.
pub mod windows_update_package {
/// Categories specified by the Windows Update.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WindowsUpdateCategory {
/// The identifier of the windows update category.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The name of the windows update category.
#[prost(string, tag = "2")]
pub name: ::prost::alloc::string::String,
}
}
/// Information related to a Quick Fix Engineering package.
/// Fields are taken from Windows QuickFixEngineering Interface and match
/// the source names:
/// <https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WindowsQuickFixEngineeringPackage {
/// A short textual description of the QFE update.
#[prost(string, tag = "1")]
pub caption: ::prost::alloc::string::String,
/// A textual description of the QFE update.
#[prost(string, tag = "2")]
pub description: ::prost::alloc::string::String,
/// Unique identifier associated with a particular QFE update.
#[prost(string, tag = "3")]
pub hot_fix_id: ::prost::alloc::string::String,
/// Date that the QFE update was installed. Mapped from installed_on field.
#[prost(message, optional, tag = "4")]
pub install_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Details about Windows Application - based on Windows Registry.
/// All fields in this message are taken from:
/// <https://docs.microsoft.com/en-us/windows/win32/msi/uninstall-registry-key>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WindowsApplication {
/// DisplayName field from Windows Registry.
#[prost(string, tag = "1")]
pub display_name: ::prost::alloc::string::String,
/// DisplayVersion field from Windows Registry.
#[prost(string, tag = "2")]
pub display_version: ::prost::alloc::string::String,
/// Publisher field from Windows Registry.
#[prost(string, tag = "3")]
pub publisher: ::prost::alloc::string::String,
/// Installation date field from Windows Registry.
#[prost(message, optional, tag = "4")]
pub install_date: ::core::option::Option<
super::super::super::super::super::r#type::Date,
>,
/// HelpLink field from Windows Registry.
#[prost(string, tag = "5")]
pub help_link: ::prost::alloc::string::String,
}
}
/// A request message to receive task notifications.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReceiveTaskNotificationRequest {
/// Required. This is the Compute Engine instance identity token described in
/// <https://cloud.google.com/compute/docs/instances/verifying-instance-identity>
/// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
#[prost(string, tag = "1")]
pub instance_id_token: ::prost::alloc::string::String,
/// Required. The version of the agent making the request.
#[prost(string, tag = "2")]
pub agent_version: ::prost::alloc::string::String,
}
/// The streaming rpc message that will notify the agent when it has a task
/// it needs to perform on the instance.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReceiveTaskNotificationResponse {}
/// A request message for signaling the start of a task execution.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StartNextTaskRequest {
/// Required. This is the Compute Engine instance identity token described in
/// <https://cloud.google.com/compute/docs/instances/verifying-instance-identity>
/// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
#[prost(string, tag = "1")]
pub instance_id_token: ::prost::alloc::string::String,
}
/// A response message that contains the details of the task to work on.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StartNextTaskResponse {
/// The details of the task that should be worked on. Can be empty if there
/// is no new task to work on.
#[prost(message, optional, tag = "1")]
pub task: ::core::option::Option<Task>,
}
/// A request message for reporting the progress of current task.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportTaskProgressRequest {
/// Required. This is the Compute Engine instance identity token described in
/// <https://cloud.google.com/compute/docs/instances/verifying-instance-identity>
/// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
#[prost(string, tag = "1")]
pub instance_id_token: ::prost::alloc::string::String,
/// Required. Unique identifier of the task this applies to.
#[prost(string, tag = "2")]
pub task_id: ::prost::alloc::string::String,
/// Required. The type of task to report progress on.
///
/// Progress must include the appropriate message based on this enum as
/// specified below:
/// APPLY_PATCHES = ApplyPatchesTaskProgress
/// EXEC_STEP = Progress not supported for this type.
/// APPLY_CONFIG_TASK = ApplyConfigTaskProgress
#[prost(enumeration = "TaskType", tag = "3")]
pub task_type: i32,
/// Intermediate progress of the current task.
#[prost(oneof = "report_task_progress_request::Progress", tags = "4, 5, 6")]
pub progress: ::core::option::Option<report_task_progress_request::Progress>,
}
/// Nested message and enum types in `ReportTaskProgressRequest`.
pub mod report_task_progress_request {
/// Intermediate progress of the current task.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Progress {
/// Details about the progress of the apply patches task.
#[prost(message, tag = "4")]
ApplyPatchesTaskProgress(super::ApplyPatchesTaskProgress),
/// Details about the progress of the exec step task.
#[prost(message, tag = "5")]
ExecStepTaskProgress(super::ExecStepTaskProgress),
/// Details about the progress of the apply config task.
#[prost(message, tag = "6")]
ApplyConfigTaskProgress(super::ApplyConfigTaskProgress),
}
}
/// The response message after the agent reported the current task progress.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportTaskProgressResponse {
/// Instructs agent to continue or not.
#[prost(enumeration = "TaskDirective", tag = "1")]
pub task_directive: i32,
}
/// A request message for signaling the completion of a task execution.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportTaskCompleteRequest {
/// Required. This is the Compute Engine instance identity token described in
/// <https://cloud.google.com/compute/docs/instances/verifying-instance-identity>
/// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
#[prost(string, tag = "1")]
pub instance_id_token: ::prost::alloc::string::String,
/// Required. Unique identifier of the task this applies to.
#[prost(string, tag = "2")]
pub task_id: ::prost::alloc::string::String,
/// Required. The type of task to report completed.
///
/// Output must include the appropriate message based on this enum as
/// specified below:
/// APPLY_PATCHES = ApplyPatchesTaskOutput
/// EXEC_STEP = ExecStepTaskOutput
/// APPLY_CONFIG_TASK = ApplyConfigTaskOutput
#[prost(enumeration = "TaskType", tag = "3")]
pub task_type: i32,
/// Descriptive error message if the task execution ended in error.
#[prost(string, tag = "4")]
pub error_message: ::prost::alloc::string::String,
/// Final output details of the current task.
#[prost(oneof = "report_task_complete_request::Output", tags = "5, 6, 7")]
pub output: ::core::option::Option<report_task_complete_request::Output>,
}
/// Nested message and enum types in `ReportTaskCompleteRequest`.
pub mod report_task_complete_request {
/// Final output details of the current task.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Output {
/// Final output details of the apply patches task;
#[prost(message, tag = "5")]
ApplyPatchesTaskOutput(super::ApplyPatchesTaskOutput),
/// Final output details of the exec step task;
#[prost(message, tag = "6")]
ExecStepTaskOutput(super::ExecStepTaskOutput),
/// Final output details of the apply config task;
#[prost(message, tag = "7")]
ApplyConfigTaskOutput(super::ApplyConfigTaskOutput),
}
}
/// The response message after the agent signaled the current task complete.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportTaskCompleteResponse {}
/// The request message for registering the agent.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegisterAgentRequest {
/// Required. This is the Compute Engine instance identity token described in
/// <https://cloud.google.com/compute/docs/instances/verifying-instance-identity>
/// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
#[prost(string, tag = "1")]
pub instance_id_token: ::prost::alloc::string::String,
/// Required. The version of the agent.
#[prost(string, tag = "2")]
pub agent_version: ::prost::alloc::string::String,
/// Required. The capabilities supported by the agent. Supported values are:
/// PATCH_GA
/// GUEST_POLICY_BETA
/// CONFIG_V1
#[prost(string, repeated, tag = "3")]
pub supported_capabilities: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The operating system long name.
/// For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019
/// Datacenter'.
#[prost(string, tag = "4")]
pub os_long_name: ::prost::alloc::string::String,
/// The operating system short name.
/// For example, 'windows' or 'debian'.
#[prost(string, tag = "5")]
pub os_short_name: ::prost::alloc::string::String,
/// The version of the operating system.
#[prost(string, tag = "6")]
pub os_version: ::prost::alloc::string::String,
/// The system architecture of the operating system.
#[prost(string, tag = "7")]
pub os_architecture: ::prost::alloc::string::String,
}
/// The response message after the agent registered.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegisterAgentResponse {}
/// The request message for having the agent report inventory.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportInventoryRequest {
/// Required. This is the Compute Engine instance identity token described in
/// <https://cloud.google.com/compute/docs/instances/verifying-instance-identity>
/// where the audience is 'osconfig.googleapis.com' and the format is 'full'.
#[prost(string, tag = "1")]
pub instance_id_token: ::prost::alloc::string::String,
/// Required. This is a client created checksum that should be generated based on the
/// contents of the reported inventory. This will be used by the service to
/// determine if it has the latest version of inventory.
#[prost(string, tag = "2")]
pub inventory_checksum: ::prost::alloc::string::String,
/// Optional. This is the details of the inventory. Should only be provided if the
/// inventory has changed since the last report, or if instructed by the
/// service to provide full inventory.
#[prost(message, optional, tag = "3")]
pub inventory: ::core::option::Option<Inventory>,
}
/// The response message after the agent has reported inventory.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReportInventoryResponse {
/// If true, the full inventory should be reported back to the server.
#[prost(bool, tag = "1")]
pub report_full_inventory: bool,
}
/// Generated client implementations.
pub mod agent_endpoint_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// OS Config agent endpoint API.
#[derive(Debug, Clone)]
pub struct AgentEndpointServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> AgentEndpointServiceClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> AgentEndpointServiceClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + Send + Sync,
{
AgentEndpointServiceClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Stream established by client to receive Task notifications.
pub async fn receive_task_notification(
&mut self,
request: impl tonic::IntoRequest<super::ReceiveTaskNotificationRequest>,
) -> std::result::Result<
tonic::Response<
tonic::codec::Streaming<super::ReceiveTaskNotificationResponse>,
>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.osconfig.agentendpoint.v1.AgentEndpointService/ReceiveTaskNotification",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.osconfig.agentendpoint.v1.AgentEndpointService",
"ReceiveTaskNotification",
),
);
self.inner.server_streaming(req, path, codec).await
}
/// Signals the start of a task execution and returns the task info.
pub async fn start_next_task(
&mut self,
request: impl tonic::IntoRequest<super::StartNextTaskRequest>,
) -> std::result::Result<
tonic::Response<super::StartNextTaskResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.osconfig.agentendpoint.v1.AgentEndpointService/StartNextTask",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.osconfig.agentendpoint.v1.AgentEndpointService",
"StartNextTask",
),
);
self.inner.unary(req, path, codec).await
}
/// Signals an intermediary progress checkpoint in task execution.
pub async fn report_task_progress(
&mut self,
request: impl tonic::IntoRequest<super::ReportTaskProgressRequest>,
) -> std::result::Result<
tonic::Response<super::ReportTaskProgressResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.osconfig.agentendpoint.v1.AgentEndpointService/ReportTaskProgress",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.osconfig.agentendpoint.v1.AgentEndpointService",
"ReportTaskProgress",
),
);
self.inner.unary(req, path, codec).await
}
/// Signals that the task execution is complete and optionally returns the next
/// task.
pub async fn report_task_complete(
&mut self,
request: impl tonic::IntoRequest<super::ReportTaskCompleteRequest>,
) -> std::result::Result<
tonic::Response<super::ReportTaskCompleteResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.osconfig.agentendpoint.v1.AgentEndpointService/ReportTaskComplete",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.osconfig.agentendpoint.v1.AgentEndpointService",
"ReportTaskComplete",
),
);
self.inner.unary(req, path, codec).await
}
/// Registers the agent running on the VM.
pub async fn register_agent(
&mut self,
request: impl tonic::IntoRequest<super::RegisterAgentRequest>,
) -> std::result::Result<
tonic::Response<super::RegisterAgentResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.osconfig.agentendpoint.v1.AgentEndpointService/RegisterAgent",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.osconfig.agentendpoint.v1.AgentEndpointService",
"RegisterAgent",
),
);
self.inner.unary(req, path, codec).await
}
/// Reports the VMs current inventory.
pub async fn report_inventory(
&mut self,
request: impl tonic::IntoRequest<super::ReportInventoryRequest>,
) -> std::result::Result<
tonic::Response<super::ReportInventoryResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.osconfig.agentendpoint.v1.AgentEndpointService/ReportInventory",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.osconfig.agentendpoint.v1.AgentEndpointService",
"ReportInventory",
),
);
self.inner.unary(req, path, codec).await
}
}
}