1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677
|
// This file was automatically generated. DO NOT EDIT.
// If you have any remark or suggestion do not hesitate to open an issue.
// Package baremetal provides methods and message types of the baremetal v1 API.
package baremetal
import (
"bytes"
"encoding/json"
"fmt"
"net"
"net/http"
"net/url"
"strings"
"time"
"github.com/scaleway/scaleway-sdk-go/internal/errors"
"github.com/scaleway/scaleway-sdk-go/internal/marshaler"
"github.com/scaleway/scaleway-sdk-go/internal/parameter"
"github.com/scaleway/scaleway-sdk-go/namegenerator"
"github.com/scaleway/scaleway-sdk-go/scw"
)
// always import dependencies
var (
_ fmt.Stringer
_ json.Unmarshaler
_ url.URL
_ net.IP
_ http.Header
_ bytes.Reader
_ time.Time
_ = strings.Join
_ scw.ScalewayRequest
_ marshaler.Duration
_ scw.File
_ = parameter.AddToQuery
_ = namegenerator.GetRandomName
)
// API: this API allows to manage your Bare metal server
type API struct {
client *scw.Client
}
// NewAPI returns a API object from a Scaleway client.
func NewAPI(client *scw.Client) *API {
return &API{
client: client,
}
}
// PrivateNetworkAPI: elastic Metal Private Network API
type PrivateNetworkAPI struct {
client *scw.Client
}
// NewPrivateNetworkAPI returns a PrivateNetworkAPI object from a Scaleway client.
func NewPrivateNetworkAPI(client *scw.Client) *PrivateNetworkAPI {
return &PrivateNetworkAPI{
client: client,
}
}
type IPReverseStatus string
const (
// IPReverseStatusUnknown is [insert doc].
IPReverseStatusUnknown = IPReverseStatus("unknown")
// IPReverseStatusPending is [insert doc].
IPReverseStatusPending = IPReverseStatus("pending")
// IPReverseStatusActive is [insert doc].
IPReverseStatusActive = IPReverseStatus("active")
// IPReverseStatusError is [insert doc].
IPReverseStatusError = IPReverseStatus("error")
)
func (enum IPReverseStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum IPReverseStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *IPReverseStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = IPReverseStatus(IPReverseStatus(tmp).String())
return nil
}
type IPVersion string
const (
// IPVersionIPv4 is [insert doc].
IPVersionIPv4 = IPVersion("IPv4")
// IPVersionIPv6 is [insert doc].
IPVersionIPv6 = IPVersion("IPv6")
)
func (enum IPVersion) String() string {
if enum == "" {
// return default value if empty
return "IPv4"
}
return string(enum)
}
func (enum IPVersion) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *IPVersion) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = IPVersion(IPVersion(tmp).String())
return nil
}
type ListServerEventsRequestOrderBy string
const (
// ListServerEventsRequestOrderByCreatedAtAsc is [insert doc].
ListServerEventsRequestOrderByCreatedAtAsc = ListServerEventsRequestOrderBy("created_at_asc")
// ListServerEventsRequestOrderByCreatedAtDesc is [insert doc].
ListServerEventsRequestOrderByCreatedAtDesc = ListServerEventsRequestOrderBy("created_at_desc")
)
func (enum ListServerEventsRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListServerEventsRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListServerEventsRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListServerEventsRequestOrderBy(ListServerEventsRequestOrderBy(tmp).String())
return nil
}
type ListServerPrivateNetworksRequestOrderBy string
const (
// ListServerPrivateNetworksRequestOrderByCreatedAtAsc is [insert doc].
ListServerPrivateNetworksRequestOrderByCreatedAtAsc = ListServerPrivateNetworksRequestOrderBy("created_at_asc")
// ListServerPrivateNetworksRequestOrderByCreatedAtDesc is [insert doc].
ListServerPrivateNetworksRequestOrderByCreatedAtDesc = ListServerPrivateNetworksRequestOrderBy("created_at_desc")
// ListServerPrivateNetworksRequestOrderByUpdatedAtAsc is [insert doc].
ListServerPrivateNetworksRequestOrderByUpdatedAtAsc = ListServerPrivateNetworksRequestOrderBy("updated_at_asc")
// ListServerPrivateNetworksRequestOrderByUpdatedAtDesc is [insert doc].
ListServerPrivateNetworksRequestOrderByUpdatedAtDesc = ListServerPrivateNetworksRequestOrderBy("updated_at_desc")
)
func (enum ListServerPrivateNetworksRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListServerPrivateNetworksRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListServerPrivateNetworksRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListServerPrivateNetworksRequestOrderBy(ListServerPrivateNetworksRequestOrderBy(tmp).String())
return nil
}
type ListServersRequestOrderBy string
const (
// ListServersRequestOrderByCreatedAtAsc is [insert doc].
ListServersRequestOrderByCreatedAtAsc = ListServersRequestOrderBy("created_at_asc")
// ListServersRequestOrderByCreatedAtDesc is [insert doc].
ListServersRequestOrderByCreatedAtDesc = ListServersRequestOrderBy("created_at_desc")
)
func (enum ListServersRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListServersRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListServersRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListServersRequestOrderBy(ListServersRequestOrderBy(tmp).String())
return nil
}
type ListSettingsRequestOrderBy string
const (
// ListSettingsRequestOrderByCreatedAtAsc is [insert doc].
ListSettingsRequestOrderByCreatedAtAsc = ListSettingsRequestOrderBy("created_at_asc")
// ListSettingsRequestOrderByCreatedAtDesc is [insert doc].
ListSettingsRequestOrderByCreatedAtDesc = ListSettingsRequestOrderBy("created_at_desc")
)
func (enum ListSettingsRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListSettingsRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListSettingsRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListSettingsRequestOrderBy(ListSettingsRequestOrderBy(tmp).String())
return nil
}
type OfferStock string
const (
// OfferStockEmpty is [insert doc].
OfferStockEmpty = OfferStock("empty")
// OfferStockLow is [insert doc].
OfferStockLow = OfferStock("low")
// OfferStockAvailable is [insert doc].
OfferStockAvailable = OfferStock("available")
)
func (enum OfferStock) String() string {
if enum == "" {
// return default value if empty
return "empty"
}
return string(enum)
}
func (enum OfferStock) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *OfferStock) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = OfferStock(OfferStock(tmp).String())
return nil
}
type OfferSubscriptionPeriod string
const (
// OfferSubscriptionPeriodUnknownSubscriptionPeriod is [insert doc].
OfferSubscriptionPeriodUnknownSubscriptionPeriod = OfferSubscriptionPeriod("unknown_subscription_period")
// OfferSubscriptionPeriodHourly is [insert doc].
OfferSubscriptionPeriodHourly = OfferSubscriptionPeriod("hourly")
// OfferSubscriptionPeriodMonthly is [insert doc].
OfferSubscriptionPeriodMonthly = OfferSubscriptionPeriod("monthly")
)
func (enum OfferSubscriptionPeriod) String() string {
if enum == "" {
// return default value if empty
return "unknown_subscription_period"
}
return string(enum)
}
func (enum OfferSubscriptionPeriod) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *OfferSubscriptionPeriod) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = OfferSubscriptionPeriod(OfferSubscriptionPeriod(tmp).String())
return nil
}
type ServerBootType string
const (
// ServerBootTypeUnknownBootType is [insert doc].
ServerBootTypeUnknownBootType = ServerBootType("unknown_boot_type")
// ServerBootTypeNormal is [insert doc].
ServerBootTypeNormal = ServerBootType("normal")
// ServerBootTypeRescue is [insert doc].
ServerBootTypeRescue = ServerBootType("rescue")
)
func (enum ServerBootType) String() string {
if enum == "" {
// return default value if empty
return "unknown_boot_type"
}
return string(enum)
}
func (enum ServerBootType) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ServerBootType) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ServerBootType(ServerBootType(tmp).String())
return nil
}
type ServerInstallStatus string
const (
// ServerInstallStatusUnknown is [insert doc].
ServerInstallStatusUnknown = ServerInstallStatus("unknown")
// ServerInstallStatusToInstall is [insert doc].
ServerInstallStatusToInstall = ServerInstallStatus("to_install")
// ServerInstallStatusInstalling is [insert doc].
ServerInstallStatusInstalling = ServerInstallStatus("installing")
// ServerInstallStatusCompleted is [insert doc].
ServerInstallStatusCompleted = ServerInstallStatus("completed")
// ServerInstallStatusError is [insert doc].
ServerInstallStatusError = ServerInstallStatus("error")
)
func (enum ServerInstallStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum ServerInstallStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ServerInstallStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ServerInstallStatus(ServerInstallStatus(tmp).String())
return nil
}
type ServerOptionOptionStatus string
const (
// ServerOptionOptionStatusOptionStatusUnknown is [insert doc].
ServerOptionOptionStatusOptionStatusUnknown = ServerOptionOptionStatus("option_status_unknown")
// ServerOptionOptionStatusOptionStatusEnable is [insert doc].
ServerOptionOptionStatusOptionStatusEnable = ServerOptionOptionStatus("option_status_enable")
// ServerOptionOptionStatusOptionStatusEnabling is [insert doc].
ServerOptionOptionStatusOptionStatusEnabling = ServerOptionOptionStatus("option_status_enabling")
// ServerOptionOptionStatusOptionStatusDisabling is [insert doc].
ServerOptionOptionStatusOptionStatusDisabling = ServerOptionOptionStatus("option_status_disabling")
// ServerOptionOptionStatusOptionStatusError is [insert doc].
ServerOptionOptionStatusOptionStatusError = ServerOptionOptionStatus("option_status_error")
)
func (enum ServerOptionOptionStatus) String() string {
if enum == "" {
// return default value if empty
return "option_status_unknown"
}
return string(enum)
}
func (enum ServerOptionOptionStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ServerOptionOptionStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ServerOptionOptionStatus(ServerOptionOptionStatus(tmp).String())
return nil
}
type ServerPingStatus string
const (
// ServerPingStatusPingStatusUnknown is [insert doc].
ServerPingStatusPingStatusUnknown = ServerPingStatus("ping_status_unknown")
// ServerPingStatusPingStatusUp is [insert doc].
ServerPingStatusPingStatusUp = ServerPingStatus("ping_status_up")
// ServerPingStatusPingStatusDown is [insert doc].
ServerPingStatusPingStatusDown = ServerPingStatus("ping_status_down")
)
func (enum ServerPingStatus) String() string {
if enum == "" {
// return default value if empty
return "ping_status_unknown"
}
return string(enum)
}
func (enum ServerPingStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ServerPingStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ServerPingStatus(ServerPingStatus(tmp).String())
return nil
}
type ServerPrivateNetworkStatus string
const (
// ServerPrivateNetworkStatusUnknown is [insert doc].
ServerPrivateNetworkStatusUnknown = ServerPrivateNetworkStatus("unknown")
// ServerPrivateNetworkStatusAttaching is [insert doc].
ServerPrivateNetworkStatusAttaching = ServerPrivateNetworkStatus("attaching")
// ServerPrivateNetworkStatusAttached is [insert doc].
ServerPrivateNetworkStatusAttached = ServerPrivateNetworkStatus("attached")
// ServerPrivateNetworkStatusError is [insert doc].
ServerPrivateNetworkStatusError = ServerPrivateNetworkStatus("error")
// ServerPrivateNetworkStatusDetaching is [insert doc].
ServerPrivateNetworkStatusDetaching = ServerPrivateNetworkStatus("detaching")
// ServerPrivateNetworkStatusLocked is [insert doc].
ServerPrivateNetworkStatusLocked = ServerPrivateNetworkStatus("locked")
)
func (enum ServerPrivateNetworkStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum ServerPrivateNetworkStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ServerPrivateNetworkStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ServerPrivateNetworkStatus(ServerPrivateNetworkStatus(tmp).String())
return nil
}
type ServerStatus string
const (
// ServerStatusUnknown is [insert doc].
ServerStatusUnknown = ServerStatus("unknown")
// ServerStatusDelivering is [insert doc].
ServerStatusDelivering = ServerStatus("delivering")
// ServerStatusReady is [insert doc].
ServerStatusReady = ServerStatus("ready")
// ServerStatusStopping is [insert doc].
ServerStatusStopping = ServerStatus("stopping")
// ServerStatusStopped is [insert doc].
ServerStatusStopped = ServerStatus("stopped")
// ServerStatusStarting is [insert doc].
ServerStatusStarting = ServerStatus("starting")
// ServerStatusError is [insert doc].
ServerStatusError = ServerStatus("error")
// ServerStatusDeleting is [insert doc].
ServerStatusDeleting = ServerStatus("deleting")
// ServerStatusLocked is [insert doc].
ServerStatusLocked = ServerStatus("locked")
// ServerStatusOutOfStock is [insert doc].
ServerStatusOutOfStock = ServerStatus("out_of_stock")
// ServerStatusOrdered is [insert doc].
ServerStatusOrdered = ServerStatus("ordered")
// ServerStatusResetting is [insert doc].
ServerStatusResetting = ServerStatus("resetting")
)
func (enum ServerStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum ServerStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ServerStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ServerStatus(ServerStatus(tmp).String())
return nil
}
type SettingType string
const (
// SettingTypeUnknown is [insert doc].
SettingTypeUnknown = SettingType("unknown")
// SettingTypeSMTP is [insert doc].
SettingTypeSMTP = SettingType("smtp")
)
func (enum SettingType) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum SettingType) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *SettingType) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = SettingType(SettingType(tmp).String())
return nil
}
// BMCAccess: bmc access
type BMCAccess struct {
// URL: URL to access to the server console
URL string `json:"url"`
// Login: the login to use for the BMC (Baseboard Management Controller) access authentification
Login string `json:"login"`
// Password: the password to use for the BMC (Baseboard Management Controller) access authentification
Password string `json:"password"`
// ExpiresAt: the date after which the BMC (Baseboard Management Controller) access will be closed
ExpiresAt *time.Time `json:"expires_at"`
}
// CPU: cpu
type CPU struct {
// Name: name of the CPU
Name string `json:"name"`
// CoreCount: number of cores of the CPU
CoreCount uint32 `json:"core_count"`
// ThreadCount: number of threads of the CPU
ThreadCount uint32 `json:"thread_count"`
// Frequency: frequency of the CPU in MHz
Frequency uint32 `json:"frequency"`
// Benchmark: benchmark of the CPU
Benchmark string `json:"benchmark"`
}
// CreateServerRequestInstall: create server request. install
type CreateServerRequestInstall struct {
// OsID: ID of the OS to install on the server
OsID string `json:"os_id"`
// Hostname: hostname of the server
Hostname string `json:"hostname"`
// SSHKeyIDs: SSH key IDs authorized on the server
SSHKeyIDs []string `json:"ssh_key_ids"`
// User: user used for the installation
User *string `json:"user"`
// Password: password used for the installation
Password *string `json:"password"`
// ServiceUser: user used for the service to install
ServiceUser *string `json:"service_user"`
// ServicePassword: password used for the service to install
ServicePassword *string `json:"service_password"`
}
// Disk: disk
type Disk struct {
// Capacity: capacity of the disk in bytes
Capacity scw.Size `json:"capacity"`
// Type: type of the disk
Type string `json:"type"`
}
// GetServerMetricsResponse: get server metrics response
type GetServerMetricsResponse struct {
// Pings: timeseries of ping on the server
Pings *scw.TimeSeries `json:"pings"`
}
// IP: ip
type IP struct {
// ID: ID of the IP
ID string `json:"id"`
// Address: address of the IP
Address net.IP `json:"address"`
// Reverse: reverse IP value
Reverse string `json:"reverse"`
// Version: version of IP (v4 or v6)
//
// Default value: IPv4
Version IPVersion `json:"version"`
// ReverseStatus: status of the reverse
//
// Default value: unknown
ReverseStatus IPReverseStatus `json:"reverse_status"`
// ReverseStatusMessage: a message related to the reverse status, in case of an error for example
ReverseStatusMessage string `json:"reverse_status_message"`
}
// ListOSResponse: list os response
type ListOSResponse struct {
// TotalCount: total count of matching OS
TotalCount uint32 `json:"total_count"`
// Os: oS that match filters
Os []*OS `json:"os"`
}
// ListOffersResponse: list offers response
type ListOffersResponse struct {
// TotalCount: total count of matching offers
TotalCount uint32 `json:"total_count"`
// Offers: offers that match filters
Offers []*Offer `json:"offers"`
}
// ListOptionsResponse: list options response
type ListOptionsResponse struct {
// TotalCount: total count of matching options
TotalCount uint32 `json:"total_count"`
// Options: options that match filters
Options []*Option `json:"options"`
}
// ListServerEventsResponse: list server events response
type ListServerEventsResponse struct {
// TotalCount: total count of matching events
TotalCount uint32 `json:"total_count"`
// Events: server events that match filters
Events []*ServerEvent `json:"events"`
}
type ListServerPrivateNetworksResponse struct {
ServerPrivateNetworks []*ServerPrivateNetwork `json:"server_private_networks"`
TotalCount uint32 `json:"total_count"`
}
// ListServersResponse: list servers response
type ListServersResponse struct {
// TotalCount: total count of matching servers
TotalCount uint32 `json:"total_count"`
// Servers: servers that match filters
Servers []*Server `json:"servers"`
}
// ListSettingsResponse: list settings response
type ListSettingsResponse struct {
// TotalCount: total count of matching sttings
TotalCount uint32 `json:"total_count"`
// Settings: settings that match filters
Settings []*Setting `json:"settings"`
}
// Memory: memory
type Memory struct {
// Capacity: capacity of the memory in bytes
Capacity scw.Size `json:"capacity"`
// Type: type of the memory
Type string `json:"type"`
// Frequency: frequency of the memory in MHz
Frequency uint32 `json:"frequency"`
// IsEcc: true if the memory is an error-correcting code memory
IsEcc bool `json:"is_ecc"`
}
// OS: os
type OS struct {
// ID: ID of the OS
ID string `json:"id"`
// Name: name of the OS
Name string `json:"name"`
// Version: version of the OS
Version string `json:"version"`
// LogoURL: URL of this os's logo
LogoURL string `json:"logo_url"`
// SSH: define the SSH requirements to install the OS
SSH *OSOSField `json:"ssh"`
// User: define the username requirements to install the OS
User *OSOSField `json:"user"`
// Password: define the password requirements to install the OS
Password *OSOSField `json:"password"`
// ServiceUser: define the username requirements to install the service
ServiceUser *OSOSField `json:"service_user"`
// ServicePassword: define the password requirements to install the service
ServicePassword *OSOSField `json:"service_password"`
// Enabled: state of OS
Enabled bool `json:"enabled"`
// LicenseRequired: license required (check server options for pricing details)
LicenseRequired bool `json:"license_required"`
}
type OSOSField struct {
Editable bool `json:"editable"`
Required bool `json:"required"`
DefaultValue *string `json:"default_value"`
}
// Offer: offer
type Offer struct {
// ID: ID of the offer
ID string `json:"id"`
// Name: name of the offer
Name string `json:"name"`
// Stock: stock level
//
// Default value: empty
Stock OfferStock `json:"stock"`
// Bandwidth: bandwidth available in bits/s with the offer
Bandwidth uint64 `json:"bandwidth"`
// CommercialRange: commercial range of the offer
CommercialRange string `json:"commercial_range"`
// PricePerHour: price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32)
PricePerHour *scw.Money `json:"price_per_hour"`
// PricePerMonth: price of the offer per months
PricePerMonth *scw.Money `json:"price_per_month"`
// Disks: disks specifications of the offer
Disks []*Disk `json:"disks"`
// Enable: true if the offer is currently available
Enable bool `json:"enable"`
// CPUs: CPU specifications of the offer
CPUs []*CPU `json:"cpus"`
// Memories: memory specifications of the offer
Memories []*Memory `json:"memories"`
// QuotaName: name of the quota associated to the offer
QuotaName string `json:"quota_name"`
// PersistentMemories: persistent memory specifications of the offer
PersistentMemories []*PersistentMemory `json:"persistent_memories"`
// RaidControllers: raid controller specifications of the offer
RaidControllers []*RaidController `json:"raid_controllers"`
// IncompatibleOsIDs: array of incompatible OS ids
IncompatibleOsIDs []string `json:"incompatible_os_ids"`
// SubscriptionPeriod: period of subscription for the offer
//
// Default value: unknown_subscription_period
SubscriptionPeriod OfferSubscriptionPeriod `json:"subscription_period"`
// OperationPath: operation path of the service
OperationPath string `json:"operation_path"`
// Fee: fee to pay on order
Fee *scw.Money `json:"fee"`
// Options: options available on offer
Options []*OfferOptionOffer `json:"options"`
}
// OfferOptionOffer: offer. option offer
type OfferOptionOffer struct {
// ID: ID of the option
ID string `json:"id"`
// Name: name of the option
Name string `json:"name"`
// Enabled: if true the option is enabled and included by default in the offer
// If false the option is available for the offer but not included by default
//
Enabled bool `json:"enabled"`
// SubscriptionPeriod: period of subscription for the offer
//
// Default value: unknown_subscription_period
SubscriptionPeriod OfferSubscriptionPeriod `json:"subscription_period"`
// Price: price of the option
Price *scw.Money `json:"price"`
// Manageable: boolean to know if option could be managed
Manageable bool `json:"manageable"`
// OsID: ID of the OS linked to the option
OsID *string `json:"os_id"`
}
// Option: option
type Option struct {
// ID: ID of the option
ID string `json:"id"`
// Name: name of the option
Name string `json:"name"`
// Manageable: is false if the option could not be added or removed
Manageable bool `json:"manageable"`
}
// PersistentMemory: persistent memory
type PersistentMemory struct {
// Capacity: capacity of the memory in bytes
Capacity scw.Size `json:"capacity"`
// Type: type of the memory
Type string `json:"type"`
// Frequency: frequency of the memory in MHz
Frequency uint32 `json:"frequency"`
}
type RaidController struct {
Model string `json:"model"`
RaidLevel []string `json:"raid_level"`
}
// Server: server
type Server struct {
// ID: ID of the server
ID string `json:"id"`
// OrganizationID: organization ID the server is attached to
OrganizationID string `json:"organization_id"`
// ProjectID: project ID the server is attached to
ProjectID string `json:"project_id"`
// Name: name of the server
Name string `json:"name"`
// Description: description of the server
Description string `json:"description"`
// UpdatedAt: date of last modification of the server
UpdatedAt *time.Time `json:"updated_at"`
// CreatedAt: date of creation of the server
CreatedAt *time.Time `json:"created_at"`
// Status: status of the server
//
// Default value: unknown
Status ServerStatus `json:"status"`
// OfferID: offer ID of the server
OfferID string `json:"offer_id"`
// OfferName: offer name of the server
OfferName string `json:"offer_name"`
// Tags: array of customs tags attached to the server
Tags []string `json:"tags"`
// IPs: array of IPs attached to the server
IPs []*IP `json:"ips"`
// Domain: domain of the server
Domain string `json:"domain"`
// BootType: boot type of the server
//
// Default value: unknown_boot_type
BootType ServerBootType `json:"boot_type"`
// Zone: the zone in which is the server
Zone scw.Zone `json:"zone"`
// Install: configuration of installation
Install *ServerInstall `json:"install"`
// PingStatus: server status of ping
//
// Default value: ping_status_unknown
PingStatus ServerPingStatus `json:"ping_status"`
// Options: options enabled on server
Options []*ServerOption `json:"options"`
// RescueServer: configuration of rescue boot
RescueServer *ServerRescueServer `json:"rescue_server"`
}
// ServerEvent: server event
type ServerEvent struct {
// ID: ID of the server for whom the action will be applied
ID string `json:"id"`
// Action: the action that will be applied to the server
Action string `json:"action"`
// UpdatedAt: date of last modification of the action
UpdatedAt *time.Time `json:"updated_at"`
// CreatedAt: date of creation of the action
CreatedAt *time.Time `json:"created_at"`
}
// ServerInstall: server. install
type ServerInstall struct {
// OsID: ID of the OS
OsID string `json:"os_id"`
// Hostname: host defined in the server install
Hostname string `json:"hostname"`
// SSHKeyIDs: SSH public key IDs defined in the server install
SSHKeyIDs []string `json:"ssh_key_ids"`
// Status: status of the server install
//
// Default value: unknown
Status ServerInstallStatus `json:"status"`
// User: user defined in the server install or the default one if none were specified
User string `json:"user"`
// ServiceUser: service user defined in the server install or the default one if none were specified
ServiceUser string `json:"service_user"`
// ServiceURL: the address of the installed service
ServiceURL string `json:"service_url"`
}
// ServerOption: server. option
type ServerOption struct {
// ID: ID of the option
ID string `json:"id"`
// Name: name of the option
Name string `json:"name"`
// Status: status of the option
//
// Default value: option_status_unknown
Status ServerOptionOptionStatus `json:"status"`
// Manageable: is false if the option could not be added or removed
Manageable bool `json:"manageable"`
// ExpiresAt: auto expiration date for compatible options
ExpiresAt *time.Time `json:"expires_at"`
}
// ServerPrivateNetwork: server private network
type ServerPrivateNetwork struct {
// ID: the private network ID
ID string `json:"id"`
// ProjectID: the private network project ID
ProjectID string `json:"project_id"`
// ServerID: the server ID
ServerID string `json:"server_id"`
// PrivateNetworkID: the private network ID
PrivateNetworkID string `json:"private_network_id"`
// Vlan: the VLAN ID associated to the private network
Vlan *uint32 `json:"vlan"`
// Status: the configuration status of the private network
//
// Default value: unknown
Status ServerPrivateNetworkStatus `json:"status"`
// CreatedAt: the private network creation date
CreatedAt *time.Time `json:"created_at"`
// UpdatedAt: the date the private network was last modified
UpdatedAt *time.Time `json:"updated_at"`
}
// ServerRescueServer: server. rescue server
type ServerRescueServer struct {
// User: rescue user name
User string `json:"user"`
// Password: rescue password
Password string `json:"password"`
}
type SetServerPrivateNetworksResponse struct {
ServerPrivateNetworks []*ServerPrivateNetwork `json:"server_private_networks"`
}
// Setting: setting
type Setting struct {
// ID: ID of the setting
ID string `json:"id"`
// Type: type of the setting
//
// Default value: unknown
Type SettingType `json:"type"`
// ProjectID: ID of the project ID
ProjectID string `json:"project_id"`
// Enabled: the setting is enable or disable
Enabled bool `json:"enabled"`
}
// Service API
// Zones list localities the api is available in
func (s *API) Zones() []scw.Zone {
return []scw.Zone{scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneNlAms1}
}
type ListServersRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// Page: page number
Page *int32 `json:"-"`
// PageSize: number of server per page
PageSize *uint32 `json:"-"`
// OrderBy: order of the servers
//
// Default value: created_at_asc
OrderBy ListServersRequestOrderBy `json:"-"`
// Tags: filter by tags
Tags []string `json:"-"`
// Status: filter by status
Status []string `json:"-"`
// Name: filter by name
Name *string `json:"-"`
// OrganizationID: filter by organization ID
OrganizationID *string `json:"-"`
// ProjectID: filter by project ID
ProjectID *string `json:"-"`
// OptionID: filter by option ID
OptionID *string `json:"-"`
}
// ListServers: list elastic metal servers for organization
//
// List elastic metal servers for organization.
func (s *API) ListServers(req *ListServersRequest, opts ...scw.RequestOption) (*ListServersResponse, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "order_by", req.OrderBy)
parameter.AddToQuery(query, "tags", req.Tags)
parameter.AddToQuery(query, "status", req.Status)
parameter.AddToQuery(query, "name", req.Name)
parameter.AddToQuery(query, "organization_id", req.OrganizationID)
parameter.AddToQuery(query, "project_id", req.ProjectID)
parameter.AddToQuery(query, "option_id", req.OptionID)
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers",
Query: query,
Headers: http.Header{},
}
var resp ListServersResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server
ServerID string `json:"-"`
}
// GetServer: get a specific elastic metal server
//
// Get the server associated with the given ID.
func (s *API) GetServer(req *GetServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "",
Headers: http.Header{},
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type CreateServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// OfferID: offer ID of the new server
OfferID string `json:"offer_id"`
// Deprecated: OrganizationID: organization ID with which the server will be created
// Precisely one of OrganizationID, ProjectID must be set.
OrganizationID *string `json:"organization_id,omitempty"`
// ProjectID: project ID with which the server will be created
// Precisely one of OrganizationID, ProjectID must be set.
ProjectID *string `json:"project_id,omitempty"`
// Name: name of the server (≠hostname)
Name string `json:"name"`
// Description: description associated to the server, max 255 characters
Description string `json:"description"`
// Tags: tags to associate to the server
Tags []string `json:"tags"`
// Install: configuration of installation
Install *CreateServerRequestInstall `json:"install"`
// OptionIDs: iDs of options to enable on server
OptionIDs []string `json:"option_ids"`
}
// CreateServer: create an elastic metal server
//
// Create a new elastic metal server. Once the server is created, you probably want to install an OS.
func (s *API) CreateServer(req *CreateServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
defaultProjectID, exist := s.client.GetDefaultProjectID()
if exist && req.OrganizationID == nil && req.ProjectID == nil {
req.ProjectID = &defaultProjectID
}
defaultOrganizationID, exist := s.client.GetDefaultOrganizationID()
if exist && req.OrganizationID == nil && req.ProjectID == nil {
req.OrganizationID = &defaultOrganizationID
}
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type UpdateServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server to update
ServerID string `json:"-"`
// Name: name of the server (≠hostname), not updated if null
Name *string `json:"name"`
// Description: description associated to the server, max 255 characters, not updated if null
Description *string `json:"description"`
// Tags: tags associated to the server, not updated if null
Tags *[]string `json:"tags"`
}
// UpdateServer: update an elastic metal server
//
// Update the server associated with the given ID.
func (s *API) UpdateServer(req *UpdateServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "PATCH",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type InstallServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: server ID to install
ServerID string `json:"-"`
// OsID: ID of the OS to install on the server
OsID string `json:"os_id"`
// Hostname: hostname of the server
Hostname string `json:"hostname"`
// SSHKeyIDs: SSH key IDs authorized on the server
SSHKeyIDs []string `json:"ssh_key_ids"`
// User: user used for the installation
User *string `json:"user"`
// Password: password used for the installation
Password *string `json:"password"`
// ServiceUser: user used for the service to install
ServiceUser *string `json:"service_user"`
// ServicePassword: password used for the service to install
ServicePassword *string `json:"service_password"`
}
// InstallServer: install an elastic metal server
//
// Install an OS on the server associated with the given ID.
func (s *API) InstallServer(req *InstallServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/install",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetServerMetricsRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: server ID to get the metrics
ServerID string `json:"-"`
}
// GetServerMetrics: return server metrics
//
// Give the ping status on the server associated with the given ID.
func (s *API) GetServerMetrics(req *GetServerMetricsRequest, opts ...scw.RequestOption) (*GetServerMetricsResponse, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/metrics",
Headers: http.Header{},
}
var resp GetServerMetricsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type DeleteServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server to delete
ServerID string `json:"-"`
}
// DeleteServer: delete an elastic metal server
//
// Delete the server associated with the given ID.
func (s *API) DeleteServer(req *DeleteServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "DELETE",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "",
Headers: http.Header{},
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type RebootServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server to reboot
ServerID string `json:"-"`
// BootType: the type of boot
//
// Default value: unknown_boot_type
BootType ServerBootType `json:"boot_type"`
}
// RebootServer: reboot an elastic metal server
//
// Reboot the server associated with the given ID, use boot param to reboot in rescue.
func (s *API) RebootServer(req *RebootServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/reboot",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type StartServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server to start
ServerID string `json:"-"`
// BootType: the type of boot
//
// Default value: unknown_boot_type
BootType ServerBootType `json:"boot_type"`
}
// StartServer: start an elastic metal server
//
// Start the server associated with the given ID.
func (s *API) StartServer(req *StartServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/start",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type StopServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server to stop
ServerID string `json:"-"`
}
// StopServer: stop an elastic metal server
//
// Stop the server associated with the given ID.
func (s *API) StopServer(req *StopServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/stop",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListServerEventsRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server events searched
ServerID string `json:"-"`
// Page: page number
Page *int32 `json:"-"`
// PageSize: number of server events per page
PageSize *uint32 `json:"-"`
// OrderBy: order of the server events
//
// Default value: created_at_asc
OrderBy ListServerEventsRequestOrderBy `json:"-"`
}
// ListServerEvents: list server events
//
// List events associated to the given server ID.
func (s *API) ListServerEvents(req *ListServerEventsRequest, opts ...scw.RequestOption) (*ListServerEventsResponse, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "order_by", req.OrderBy)
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/events",
Query: query,
Headers: http.Header{},
}
var resp ListServerEventsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type StartBMCAccessRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server
ServerID string `json:"-"`
// IP: the IP authorized to connect to the given server
IP net.IP `json:"ip"`
}
// StartBMCAccess: start BMC (Baseboard Management Controller) access for a given elastic metal server
//
// Start BMC (Baseboard Management Controller) access associated with the given ID.
// The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.
// You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option.
// After start BMC, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
//
func (s *API) StartBMCAccess(req *StartBMCAccessRequest, opts ...scw.RequestOption) (*BMCAccess, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/bmc-access",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp BMCAccess
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetBMCAccessRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server
ServerID string `json:"-"`
}
// GetBMCAccess: get BMC (Baseboard Management Controller) access for a given elastic metal server
//
// Get the BMC (Baseboard Management Controller) access associated with the given ID.
func (s *API) GetBMCAccess(req *GetBMCAccessRequest, opts ...scw.RequestOption) (*BMCAccess, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/bmc-access",
Headers: http.Header{},
}
var resp BMCAccess
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type StopBMCAccessRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server
ServerID string `json:"-"`
}
// StopBMCAccess: stop BMC (Baseboard Management Controller) access for a given elastic metal server
//
// Stop BMC (Baseboard Management Controller) access associated with the given ID.
func (s *API) StopBMCAccess(req *StopBMCAccessRequest, opts ...scw.RequestOption) error {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "DELETE",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/bmc-access",
Headers: http.Header{},
}
err = s.client.Do(scwReq, nil, opts...)
if err != nil {
return err
}
return nil
}
type UpdateIPRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server
ServerID string `json:"-"`
// IPID: ID of the IP to update
IPID string `json:"-"`
// Reverse: new reverse IP to update, not updated if null
Reverse *string `json:"reverse"`
}
// UpdateIP: update IP
//
// Configure ip associated with the given server ID and ipID. You can use this method to set a reverse dns for an IP.
func (s *API) UpdateIP(req *UpdateIPRequest, opts ...scw.RequestOption) (*IP, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
if fmt.Sprint(req.IPID) == "" {
return nil, errors.New("field IPID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "PATCH",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/ips/" + fmt.Sprint(req.IPID) + "",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp IP
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type AddOptionServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server
ServerID string `json:"-"`
// OptionID: ID of the option to add
OptionID string `json:"-"`
// ExpiresAt: auto expire the option after this date
ExpiresAt *time.Time `json:"expires_at"`
}
// AddOptionServer: add server option
//
// Add an option to a specific server.
func (s *API) AddOptionServer(req *AddOptionServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
if fmt.Sprint(req.OptionID) == "" {
return nil, errors.New("field OptionID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/options/" + fmt.Sprint(req.OptionID) + "",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type DeleteOptionServerRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: ID of the server
ServerID string `json:"-"`
// OptionID: ID of the option to delete
OptionID string `json:"-"`
}
// DeleteOptionServer: delete server option
//
// Delete an option from a specific server.
func (s *API) DeleteOptionServer(req *DeleteOptionServerRequest, opts ...scw.RequestOption) (*Server, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
if fmt.Sprint(req.OptionID) == "" {
return nil, errors.New("field OptionID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "DELETE",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/options/" + fmt.Sprint(req.OptionID) + "",
Headers: http.Header{},
}
var resp Server
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListOffersRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// Page: page number
Page *int32 `json:"-"`
// PageSize: number of offers per page
PageSize *uint32 `json:"-"`
// SubscriptionPeriod: period of subscription to filter offers
//
// Default value: unknown_subscription_period
SubscriptionPeriod OfferSubscriptionPeriod `json:"-"`
}
// ListOffers: list offers
//
// List all available server offers.
func (s *API) ListOffers(req *ListOffersRequest, opts ...scw.RequestOption) (*ListOffersResponse, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "subscription_period", req.SubscriptionPeriod)
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/offers",
Query: query,
Headers: http.Header{},
}
var resp ListOffersResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetOfferRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// OfferID: ID of the researched Offer
OfferID string `json:"-"`
}
// GetOffer: get offer
//
// Return specific offer for the given ID.
func (s *API) GetOffer(req *GetOfferRequest, opts ...scw.RequestOption) (*Offer, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.OfferID) == "" {
return nil, errors.New("field OfferID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/offers/" + fmt.Sprint(req.OfferID) + "",
Headers: http.Header{},
}
var resp Offer
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetOptionRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// OptionID: ID of the option
OptionID string `json:"-"`
}
// GetOption: get option
//
// Return specific option for the given ID.
func (s *API) GetOption(req *GetOptionRequest, opts ...scw.RequestOption) (*Option, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.OptionID) == "" {
return nil, errors.New("field OptionID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/options/" + fmt.Sprint(req.OptionID) + "",
Headers: http.Header{},
}
var resp Option
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListOptionsRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// Page: page number
Page *int32 `json:"-"`
// PageSize: number of options per page
PageSize *uint32 `json:"-"`
// OfferID: filter options by offer_id
OfferID *string `json:"-"`
// Name: filter options by name
Name *string `json:"-"`
}
// ListOptions: list options
//
// List all options matching with filters.
func (s *API) ListOptions(req *ListOptionsRequest, opts ...scw.RequestOption) (*ListOptionsResponse, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "offer_id", req.OfferID)
parameter.AddToQuery(query, "name", req.Name)
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/options",
Query: query,
Headers: http.Header{},
}
var resp ListOptionsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListSettingsRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// Page: page number
Page *int32 `json:"-"`
// PageSize: set the maximum list size
PageSize *uint32 `json:"-"`
// OrderBy: order the response
//
// Default value: created_at_asc
OrderBy ListSettingsRequestOrderBy `json:"-"`
// ProjectID: ID of the project
ProjectID *string `json:"-"`
}
// ListSettings: list all settings
//
// Return all settings for a project ID.
func (s *API) ListSettings(req *ListSettingsRequest, opts ...scw.RequestOption) (*ListSettingsResponse, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "order_by", req.OrderBy)
parameter.AddToQuery(query, "project_id", req.ProjectID)
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/settings",
Query: query,
Headers: http.Header{},
}
var resp ListSettingsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type UpdateSettingRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// SettingID: ID of the setting
SettingID string `json:"-"`
// Enabled: enable/Disable the setting
Enabled *bool `json:"enabled"`
}
// UpdateSetting: update setting
//
// Update a setting for a project ID (enable or disable).
func (s *API) UpdateSetting(req *UpdateSettingRequest, opts ...scw.RequestOption) (*Setting, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.SettingID) == "" {
return nil, errors.New("field SettingID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "PATCH",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/settings/" + fmt.Sprint(req.SettingID) + "",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Setting
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListOSRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// Page: page number
Page *int32 `json:"-"`
// PageSize: number of OS per page
PageSize *uint32 `json:"-"`
// OfferID: filter OS by offer ID
OfferID *string `json:"-"`
}
// ListOS: list all available OS that can be install on an elastic metal server
//
// List all available OS that can be install on an elastic metal server.
func (s *API) ListOS(req *ListOSRequest, opts ...scw.RequestOption) (*ListOSResponse, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "offer_id", req.OfferID)
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/os",
Query: query,
Headers: http.Header{},
}
var resp ListOSResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetOSRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// OsID: ID of the OS
OsID string `json:"-"`
}
// GetOS: get an OS with a given ID
//
// Return specific OS for the given ID.
func (s *API) GetOS(req *GetOSRequest, opts ...scw.RequestOption) (*OS, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.OsID) == "" {
return nil, errors.New("field OsID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/os/" + fmt.Sprint(req.OsID) + "",
Headers: http.Header{},
}
var resp OS
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// Service PrivateNetworkAPI
// Zones list localities the api is available in
func (s *PrivateNetworkAPI) Zones() []scw.Zone {
return []scw.Zone{scw.ZoneFrPar2}
}
type PrivateNetworkAPIAddServerPrivateNetworkRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: the ID of the server
ServerID string `json:"-"`
// PrivateNetworkID: the ID of the private network
PrivateNetworkID string `json:"private_network_id"`
}
// AddServerPrivateNetwork: add a server to a private network
func (s *PrivateNetworkAPI) AddServerPrivateNetwork(req *PrivateNetworkAPIAddServerPrivateNetworkRequest, opts ...scw.RequestOption) (*ServerPrivateNetwork, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/private-networks",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp ServerPrivateNetwork
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type PrivateNetworkAPISetServerPrivateNetworksRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: the ID of the server
ServerID string `json:"-"`
// PrivateNetworkIDs: the IDs of the private networks
PrivateNetworkIDs []string `json:"private_network_ids"`
}
// SetServerPrivateNetworks: set multiple private networks on a server
func (s *PrivateNetworkAPI) SetServerPrivateNetworks(req *PrivateNetworkAPISetServerPrivateNetworksRequest, opts ...scw.RequestOption) (*SetServerPrivateNetworksResponse, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return nil, errors.New("field ServerID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "PUT",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/private-networks",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp SetServerPrivateNetworksResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type PrivateNetworkAPIListServerPrivateNetworksRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// OrderBy: the sort order for the returned private networks
//
// Default value: created_at_asc
OrderBy ListServerPrivateNetworksRequestOrderBy `json:"-"`
// Page: the page number for the returned private networks
Page *int32 `json:"-"`
// PageSize: the maximum number of private networks per page
PageSize *uint32 `json:"-"`
// ServerID: filter private networks by server ID
ServerID *string `json:"-"`
// PrivateNetworkID: filter private networks by private network ID
PrivateNetworkID *string `json:"-"`
// OrganizationID: filter private networks by organization ID
OrganizationID *string `json:"-"`
// ProjectID: filter private networks by project ID
ProjectID *string `json:"-"`
}
// ListServerPrivateNetworks: list the private networks of a server
func (s *PrivateNetworkAPI) ListServerPrivateNetworks(req *PrivateNetworkAPIListServerPrivateNetworksRequest, opts ...scw.RequestOption) (*ListServerPrivateNetworksResponse, error) {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "order_by", req.OrderBy)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "server_id", req.ServerID)
parameter.AddToQuery(query, "private_network_id", req.PrivateNetworkID)
parameter.AddToQuery(query, "organization_id", req.OrganizationID)
parameter.AddToQuery(query, "project_id", req.ProjectID)
if fmt.Sprint(req.Zone) == "" {
return nil, errors.New("field Zone cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/server-private-networks",
Query: query,
Headers: http.Header{},
}
var resp ListServerPrivateNetworksResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type PrivateNetworkAPIDeleteServerPrivateNetworkRequest struct {
// Zone:
//
// Zone to target. If none is passed will use default zone from the config
Zone scw.Zone `json:"-"`
// ServerID: the ID of the server
ServerID string `json:"-"`
// PrivateNetworkID: the ID of the private network
PrivateNetworkID string `json:"-"`
}
// DeleteServerPrivateNetwork: delete a private network
func (s *PrivateNetworkAPI) DeleteServerPrivateNetwork(req *PrivateNetworkAPIDeleteServerPrivateNetworkRequest, opts ...scw.RequestOption) error {
var err error
if req.Zone == "" {
defaultZone, _ := s.client.GetDefaultZone()
req.Zone = defaultZone
}
if fmt.Sprint(req.Zone) == "" {
return errors.New("field Zone cannot be empty in request")
}
if fmt.Sprint(req.ServerID) == "" {
return errors.New("field ServerID cannot be empty in request")
}
if fmt.Sprint(req.PrivateNetworkID) == "" {
return errors.New("field PrivateNetworkID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "DELETE",
Path: "/baremetal/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/private-networks/" + fmt.Sprint(req.PrivateNetworkID) + "",
Headers: http.Header{},
}
err = s.client.Do(scwReq, nil, opts...)
if err != nil {
return err
}
return nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListServersResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListServersResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListServersResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Servers = append(r.Servers, results.Servers...)
r.TotalCount += uint32(len(results.Servers))
return uint32(len(results.Servers)), nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListServerEventsResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListServerEventsResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListServerEventsResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Events = append(r.Events, results.Events...)
r.TotalCount += uint32(len(results.Events))
return uint32(len(results.Events)), nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListOffersResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListOffersResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListOffersResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Offers = append(r.Offers, results.Offers...)
r.TotalCount += uint32(len(results.Offers))
return uint32(len(results.Offers)), nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListOptionsResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListOptionsResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListOptionsResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Options = append(r.Options, results.Options...)
r.TotalCount += uint32(len(results.Options))
return uint32(len(results.Options)), nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListSettingsResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListSettingsResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListSettingsResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Settings = append(r.Settings, results.Settings...)
r.TotalCount += uint32(len(results.Settings))
return uint32(len(results.Settings)), nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListOSResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListOSResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListOSResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Os = append(r.Os, results.Os...)
r.TotalCount += uint32(len(results.Os))
return uint32(len(results.Os)), nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListServerPrivateNetworksResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListServerPrivateNetworksResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListServerPrivateNetworksResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.ServerPrivateNetworks = append(r.ServerPrivateNetworks, results.ServerPrivateNetworks...)
r.TotalCount += uint32(len(results.ServerPrivateNetworks))
return uint32(len(results.ServerPrivateNetworks)), nil
}
|