1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ApigeeV1
# Apigee API
#
# Use the Apigee API to programmatically develop and manage APIs with a set of
# RESTful operations. Develop and secure API proxies, deploy and undeploy API
# proxy revisions, monitor APIs, configure environments, manage users, and more.
# Get started using the APIs. *Note:* This product is available as a free trial
# for a time period of 60 days.
#
# @example
# require 'google/apis/apigee_v1'
#
# Apigee = Google::Apis::ApigeeV1 # Alias the module
# service = Apigee::ApigeeService.new
#
# @see https://cloud.google.com/apigee-api-management/
class ApigeeService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://apigee.googleapis.com/', '')
@batch_path = 'batch'
end
# Lists hybrid services and its trusted issuers service account ids. This api is
# authenticated and unauthorized(allow all the users) and used by runtime authn-
# authz service to query control plane's issuer service account ids.
# @param [String] name
# Required. Must be of the form `hybrid/issuers`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_hybrid_issuers(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListHybridIssuersResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an Apigee organization. See [Create an Apigee organization](https://
# cloud.google.com/apigee/docs/api-platform/get-started/create-org).
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] google_cloud_apigee_v1_organization_object
# @param [String] parent
# Required. Name of the GCP project in which to associate the Apigee
# organization. Pass the information as a query parameter using the following
# structure in your request: `projects/`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization(google_cloud_apigee_v1_organization_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/organizations', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation
command.request_object = google_cloud_apigee_v1_organization_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.query['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete an Apigee organization. Only supported for SubscriptionType TRIAL.
# @param [String] name
# Required. Name of the organization. Use the following structure in your
# request: `organizations/`org``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the profile for an Apigee organization. See [Understanding organizations](
# https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-
# structure).
# @param [String] name
# Required. Apigee organization name in the following format: `organizations/`
# org``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the deployed ingress configuration for an organization.
# @param [String] name
# Required. Name of the deployed configuration for the organization in the
# following format: 'organizations/`org`/deployedIngressConfig'.
# @param [String] view
# When set to FULL, additional details about the specific deployments receiving
# traffic will be included in the IngressConfig response's RoutingRules.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1IngressConfig] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1IngressConfig]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_deployed_ingress_config(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1IngressConfig::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1IngressConfig
command.params['name'] = name unless name.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the service accounts with the permissions required to allow the
# Synchronizer to download environment data from the control plane. An ETag is
# returned in the response to `getSyncAuthorization`. Pass that ETag when
# calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are
# updating the correct version. If you don't pass the ETag in the call to `
# setSyncAuthorization`, then the existing authorization is overwritten
# indiscriminately. For more information, see [Configure the Synchronizer](https:
# //cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**:
# Available to Apigee hybrid only.
# @param [String] name
# Required. Name of the Apigee organization. Use the following structure in your
# request: `organizations/`org``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1GetSyncAuthorizationRequest] google_cloud_apigee_v1_get_sync_authorization_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_sync_authorization(name, google_cloud_apigee_v1_get_sync_authorization_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:getSyncAuthorization', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1GetSyncAuthorizationRequest::Representation
command.request_object = google_cloud_apigee_v1_get_sync_authorization_request_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the Apigee organizations and associated GCP projects that you have
# permission to access. See [Understanding organizations](https://cloud.google.
# com/apigee/docs/api-platform/fundamentals/organization-structure).
# @param [String] parent
# Required. Use the following structure in your request: `organizations`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organizations(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOrganizationsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the permissions required to allow the Synchronizer to download
# environment data from the control plane. You must call this API to enable
# proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization`
# to ensure that you are updating the correct version. To get an ETag, call [
# getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the
# call to `setSyncAuthorization`, then the existing authorization is overwritten
# indiscriminately. For more information, see [Configure the Synchronizer](https:
# //cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**:
# Available to Apigee hybrid only.
# @param [String] name
# Required. Name of the Apigee organization. Use the following structure in your
# request: `organizations/`org``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization] google_cloud_apigee_v1_sync_authorization_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_organization_sync_authorization(name, google_cloud_apigee_v1_sync_authorization_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:setSyncAuthorization', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization::Representation
command.request_object = google_cloud_apigee_v1_sync_authorization_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the properties for an Apigee organization. No other fields in the
# organization profile will be updated.
# @param [String] name
# Required. Apigee organization name in the following format: `organizations/`
# org``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] google_cloud_apigee_v1_organization_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization(name, google_cloud_apigee_v1_organization_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation
command.request_object = google_cloud_apigee_v1_organization_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create a Datastore for an org
# @param [String] parent
# Required. The parent organization name. Must be of the form `organizations/`
# org``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore] google_cloud_apigee_v1_datastore_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_analytic_datastore(parent, google_cloud_apigee_v1_datastore_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/analytics/datastores', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
command.request_object = google_cloud_apigee_v1_datastore_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete a Datastore from an org.
# @param [String] name
# Required. Resource name of the Datastore to be deleted. Must be of the form `
# organizations/`org`/analytics/datastores/`datastoreId``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_analytic_datastore(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a Datastore
# @param [String] name
# Required. Resource name of the Datastore to be get. Must be of the form `
# organizations/`org`/analytics/datastores/`datastoreId``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_analytic_datastore(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List Datastores
# @param [String] parent
# Required. The parent organization name. Must be of the form `organizations/`
# org``.
# @param [String] target_type
# Optional. TargetType is used to fetch all Datastores that match the type
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDatastoresResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDatastoresResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_analytic_datastores(parent, target_type: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/analytics/datastores', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDatastoresResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDatastoresResponse
command.params['parent'] = parent unless parent.nil?
command.query['targetType'] = target_type unless target_type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Test if Datastore configuration is correct. This includes checking if
# credentials provided by customer have required permissions in target
# destination storage
# @param [String] parent
# Required. The parent organization name Must be of the form `organizations/`org`
# `
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore] google_cloud_apigee_v1_datastore_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TestDatastoreResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TestDatastoreResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_organization_analytic_datastore(parent, google_cloud_apigee_v1_datastore_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/analytics/datastores:test', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
command.request_object = google_cloud_apigee_v1_datastore_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TestDatastoreResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TestDatastoreResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update a Datastore
# @param [String] name
# Required. The resource name of datastore to be updated. Must be of the form `
# organizations/`org`/analytics/datastores/`datastoreId``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore] google_cloud_apigee_v1_datastore_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_analytic_datastore(name, google_cloud_apigee_v1_datastore_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
command.request_object = google_cloud_apigee_v1_datastore_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates or creates API product attributes. This API **replaces** the current
# list of attributes with the attributes specified in the request body. In this
# way, you can update existing attributes, add new attributes, or delete
# existing attributes by omitting them from the request body. **Note**: OAuth
# access tokens and Key Management Service (KMS) entities (apps, developers, and
# API products) are cached for 180 seconds (current default). Any custom
# attributes associated with entities also get cached for at least 180 seconds
# after entity is accessed during runtime. In this case, the `ExpiresIn` element
# on the OAuthV2 policy won't be able to expire an access token in less than 180
# seconds.
# @param [String] name
# Required. Name of the API product. Use the following structure in your request:
# `organizations/`org`/apiproducts/`apiproduct``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def attributes_organization_apiproduct(name, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}/attributes', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
command.request_object = google_cloud_apigee_v1_attributes_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an API product in an organization. You create API products after you
# have proxied backend services using API proxies. An API product is a
# collection of API resources combined with quota settings and metadata that you
# can use to deliver customized and productized API bundles to your developer
# community. This metadata can include: - Scope - Environments - API proxies -
# Extensible profile API products enable you repackage APIs on-the-fly, without
# having to do any additional coding or configuration. Apigee recommends that
# you start with a simple API product including only required elements. You then
# provision credentials to apps to enable them to start testing your APIs. After
# you have authentication and authorization working against a simple API product,
# you can iterate to create finer grained API products, defining different sets
# of API resources for each API product. **WARNING:** - If you don't specify an
# API proxy in the request body, *any* app associated with the product can make
# calls to *any* API in your entire organization. - If you don't specify an
# environment in the request body, the product allows access to all environments.
# For more information, see What is an API product?
# @param [String] parent
# Required. Name of the organization in which the API product will be created.
# Use the following structure in your request: `organizations/`org``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] google_cloud_apigee_v1_api_product_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_apiproduct(parent, google_cloud_apigee_v1_api_product_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/apiproducts', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
command.request_object = google_cloud_apigee_v1_api_product_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an API product from an organization. Deleting an API product causes
# app requests to the resource URIs defined in the API product to fail. Ensure
# that you create a new API product to serve existing apps, unless your
# intention is to disable access to the resources defined in the API product.
# The API product name required in the request URL is the internal name of the
# product, not the display name. While they may be the same, it depends on
# whether the API product was created via the UI or the API. View the list of
# API products to verify the internal name.
# @param [String] name
# Required. Name of the API product. Use the following structure in your request:
# `organizations/`org`/apiproducts/`apiproduct``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets configuration details for an API product. The API product name required
# in the request URL is the internal name of the product, not the display name.
# While they may be the same, it depends on whether the API product was created
# via the UI or the API. View the list of API products to verify the internal
# name.
# @param [String] name
# Required. Name of the API product. Use the following structure in your request:
# `organizations/`org`/apiproducts/`apiproduct``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all API product names for an organization. Filter the list by passing an
# `attributename` and `attibutevalue`. The limit on the number of API products
# returned by the API is 1000. You can paginate the list of API products
# returned using the `startKey` and `count` query parameters.
# @param [String] parent
# Required. Name of the organization. Use the following structure in your
# request: `organizations/`org``
# @param [String] attributename
# Name of the attribute used to filter the search.
# @param [String] attributevalue
# Value of the attribute used to filter the search.
# @param [Fixnum] count
# Enter the number of API products you want returned in the API call. The limit
# is 1000.
# @param [Boolean] expand
# Flag that specifies whether to expand the results. Set to `true` to get
# expanded details about each API.
# @param [String] start_key
# Gets a list of API products starting with a specific API product in the list.
# For example, if you're returning 50 API products at a time (using the `count`
# query parameter), you can view products 50-99 by entering the name of the 50th
# API product in the first API (without using `startKey`). Product name is case
# sensitive.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_apiproducts(parent, attributename: nil, attributevalue: nil, count: nil, expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/apiproducts', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProductsResponse
command.params['parent'] = parent unless parent.nil?
command.query['attributename'] = attributename unless attributename.nil?
command.query['attributevalue'] = attributevalue unless attributevalue.nil?
command.query['count'] = count unless count.nil?
command.query['expand'] = expand unless expand.nil?
command.query['startKey'] = start_key unless start_key.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an existing API product. You must include all required values, whether
# or not you are updating them, as well as any optional values that you are
# updating. The API product name required in the request URL is the internal
# name of the product, not the Display Name. While they may be the same, it
# depends on whether the API product was created via UI or API. View the list of
# API products to identify their internal names.
# @param [String] name
# Required. Name of the API product. Use the following structure in your request:
# `organizations/`org`/apiproducts/`apiproduct``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] google_cloud_apigee_v1_api_product_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_apiproduct(name, google_cloud_apigee_v1_api_product_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
command.request_object = google_cloud_apigee_v1_api_product_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an API product attribute.
# @param [String] name
# Required. Name of the API product attribute. Use the following structure in
# your request: `organizations/`org`/apiproducts/`apiproduct`/attributes/`
# attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_apiproduct_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the value of an API product attribute.
# @param [String] name
# Required. Name of the API product attribute. Use the following structure in
# your request: `organizations/`org`/apiproducts/`apiproduct`/attributes/`
# attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_apiproduct_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all API product attributes.
# @param [String] parent
# Required. Name of the API product. Use the following structure in your request:
# `organizations/`org`/apiproducts/`apiproduct``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_apiproduct_attributes(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/attributes', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the value of an API product attribute. **Note**: OAuth access tokens
# and Key Management Service (KMS) entities (apps, developers, and API products)
# are cached for 180 seconds (current default). Any custom attributes associated
# with entities also get cached for at least 180 seconds after entity is
# accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2
# policy won't be able to expire an access token in less than 180 seconds.
# @param [String] name
# Required. Name of the API product. Use the following structure in your request:
# `organizations/`org`/apiproducts/`apiproduct``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_apiproduct_attribute_api_product_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.request_object = google_cloud_apigee_v1_attribute_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an API proxy. The API proxy created will not be accessible at runtime
# until it is deployed to an environment. Create a new API proxy by setting the `
# name` query parameter to the name of the API proxy. Import an API proxy
# configuration bundle stored in zip format on your local machine to your
# organization by doing the following: * Set the `name` query parameter to the
# name of the API proxy. * Set the `action` query parameter to `import`. * Set
# the `Content-Type` header to `multipart/form-data`. * Pass as a file the name
# of API proxy configuration bundle stored in zip format on your local machine
# using the `file` form field. **Note**: To validate the API proxy configuration
# bundle only without importing it, set the `action` query parameter to `
# validate`. When importing an API proxy configuration bundle, if the API proxy
# does not exist, it will be created. If the API proxy exists, then a new
# revision is created. Invalid API proxy configurations are rejected, and a list
# of validation errors is returned to the client.
# @param [String] parent
# Required. Name of the organization in the following format: `organizations/`
# org``
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [String] action
# Action to perform when importing an API proxy configuration bundle. Set this
# parameter to one of the following values: * `import` to import the API proxy
# configuration bundle. * `validate` to validate the API proxy configuration
# bundle without importing it.
# @param [String] name
# Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
# @param [Boolean] validate
# Ignored. All uploads are validated regardless of the value of this field.
# Maintained for compatibility with Apigee Edge API.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_api(parent, google_api_http_body_object = nil, action: nil, name: nil, validate: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/apis', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.request_object = google_api_http_body_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision
command.params['parent'] = parent unless parent.nil?
command.query['action'] = action unless action.nil?
command.query['name'] = name unless name.nil?
command.query['validate'] = validate unless validate.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an API proxy and all associated endpoints, policies, resources, and
# revisions. The API proxy must be undeployed before you can delete it.
# @param [String] name
# Required. Name of the API proxy in the following format: `organizations/`org`/
# apis/`api``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_api(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets an API proxy including a list of existing revisions.
# @param [String] name
# Required. Name of the API proxy in the following format: `organizations/`org`/
# apis/`api``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_api(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxy
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the names of all API proxies in an organization. The names returned
# correspond to the names defined in the configuration files for each API proxy.
# @param [String] parent
# Required. Name of the organization in the following format: `organizations/`
# org``
# @param [Boolean] include_meta_data
# Flag that specifies whether to include API proxy metadata in the response.
# @param [Boolean] include_revisions
# Flag that specifies whether to include a list of revisions in the response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_apis(parent, include_meta_data: nil, include_revisions: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/apis', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiProxiesResponse
command.params['parent'] = parent unless parent.nil?
command.query['includeMetaData'] = include_meta_data unless include_meta_data.nil?
command.query['includeRevisions'] = include_revisions unless include_revisions.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of an API proxy.
# @param [String] parent
# Required. Name of the API proxy for which to return deployment information in
# the following format: `organizations/`org`/apis/`api``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_api_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a key value map in an api proxy.
# @param [String] parent
# Required. The name of the environment in which to create the key value map.
# Must be of the form `organizations/`organization`/apis/`api``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_api_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/keyvaluemaps', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
command.request_object = google_cloud_apigee_v1_key_value_map_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete a key value map in an api proxy.
# @param [String] name
# Required. The name of the key value map. Must be of the form `organizations/`
# organization`/apis/`api`/keyvaluemaps/`keyvaluemap``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_api_keyvaluemap(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an API proxy revision and all policies, resources, endpoints, and
# revisions associated with it. The API proxy revision must be undeployed before
# you can delete it.
# @param [String] name
# Required. API proxy revision in the following format: `organizations/`org`/
# apis/`api`/revisions/`rev``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_api_revision(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets an API proxy revision. To download the API proxy configuration bundle for
# the specified revision as a zip file, do the following: * Set the `format`
# query parameter to `bundle`. * Set the `Accept` header to `application/zip`.
# If you are using curl, specify `-o filename.zip` to save the output to a file;
# otherwise, it displays to `stdout`. Then, develop the API proxy configuration
# locally and upload the updated API proxy configuration revision, as described
# in [updateApiProxyRevision](updateApiProxyRevision).
# @param [String] name
# Required. API proxy revision in the following format: `organizations/`org`/
# apis/`api`/revisions/`rev``
# @param [String] format
# Format used when downloading the API proxy configuration revision. Set to `
# bundle` to download the API proxy configuration revision as a zip file.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_api_revision(name, format: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
command.params['name'] = name unless name.nil?
command.query['format'] = format unless format.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an existing API proxy revision by uploading the API proxy
# configuration bundle as a zip file from your local machine. You can update
# only API proxy revisions that have never been deployed. After deployment, an
# API proxy revision becomes immutable, even if it is undeployed. Set the `
# Content-Type` header to either `multipart/form-data` or `application/octet-
# stream`.
# @param [String] name
# Required. API proxy revision to update in the following format: `organizations/
# `org`/apis/`api`/revisions/`rev``
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [Boolean] validate
# Ignored. All uploads are validated regardless of the value of this field.
# Maintained for compatibility with Apigee Edge API.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_api_revision_api_proxy_revision(name, google_api_http_body_object = nil, validate: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.request_object = google_api_http_body_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision
command.params['name'] = name unless name.nil?
command.query['validate'] = validate unless validate.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of an API proxy revision.
# @param [String] parent
# Required. Name of the API proxy revision for which to return deployment
# information in the following format: `organizations/`org`/apis/`api`/revisions/
# `rev``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_api_revision_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the app profile for the specified app ID.
# @param [String] name
# Required. App ID in the following format: `organizations/`org`/apps/`app``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1App] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1App]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_app(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1App::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1App
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists IDs of apps within an organization that have the specified app status (
# approved or revoked) or are of the specified app type (developer or company).
# @param [String] parent
# Required. Resource path of the parent in the following format: `organizations/`
# org``
# @param [String] api_product
# API product.
# @param [String] apptype
# Optional. Filter by the type of the app. Valid values are `company` or `
# developer`. Defaults to `developer`.
# @param [Boolean] expand
# Optional. Flag that specifies whether to return an expanded list of apps for
# the organization. Defaults to `false`.
# @param [String] ids
# Optional. Comma-separated list of app IDs on which to filter.
# @param [Boolean] include_cred
# Optional. Flag that specifies whether to include credentials in the response.
# @param [String] key_status
# Optional. Key status of the app. Valid values include `approved` or `revoked`.
# Defaults to `approved`.
# @param [Fixnum] rows
# Optional. Maximum number of app IDs to return. Defaults to 10000.
# @param [String] start_key
# Returns the list of apps starting from the specified app ID.
# @param [String] status
# Optional. Filter by the status of the app. Valid values are `approved` or `
# revoked`. Defaults to `approved`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_apps(parent, api_product: nil, apptype: nil, expand: nil, ids: nil, include_cred: nil, key_status: nil, rows: nil, start_key: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/apps', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse
command.params['parent'] = parent unless parent.nil?
command.query['apiProduct'] = api_product unless api_product.nil?
command.query['apptype'] = apptype unless apptype.nil?
command.query['expand'] = expand unless expand.nil?
command.query['ids'] = ids unless ids.nil?
command.query['includeCred'] = include_cred unless include_cred.nil?
command.query['keyStatus'] = key_status unless key_status.nil?
command.query['rows'] = rows unless rows.nil?
command.query['startKey'] = start_key unless start_key.nil?
command.query['status'] = status unless status.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new data collector.
# @param [String] parent
# Required. Name of the organization in which to create the data collector in
# the following format: `organizations/`org``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector] google_cloud_apigee_v1_data_collector_object
# @param [String] data_collector_id
# ID of the data collector. Overrides any ID in the data collector resource.
# Must begin with `dc_`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_datacollector(parent, google_cloud_apigee_v1_data_collector_object = nil, data_collector_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/datacollectors', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
command.request_object = google_cloud_apigee_v1_data_collector_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector
command.params['parent'] = parent unless parent.nil?
command.query['dataCollectorId'] = data_collector_id unless data_collector_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a data collector.
# @param [String] name
# Required. Name of the data collector in the following format: `organizations/`
# org`/datacollectors/`data_collector_id``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_datacollector(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a data collector.
# @param [String] name
# Required. Name of the data collector in the following format: `organizations/`
# org`/datacollectors/`data_collector_id``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_datacollector(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all data collectors.
# @param [String] parent
# Required. Name of the organization for which to list data collectors in the
# following format: `organizations/`org``.
# @param [Fixnum] page_size
# Maximum number of data collectors to return. The page size defaults to 25.
# @param [String] page_token
# Page token, returned from a previous ListDataCollectors call, that you can use
# to retrieve the next page.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDataCollectorsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDataCollectorsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_datacollectors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/datacollectors', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDataCollectorsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDataCollectorsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a data collector.
# @param [String] name
# Required. Name of the data collector in the following format: `organizations/`
# org`/datacollectors/`data_collector_id``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector] google_cloud_apigee_v1_data_collector_object
# @param [String] update_mask
# List of fields to be updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_organization_datacollector(name, google_cloud_apigee_v1_data_collector_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
command.request_object = google_cloud_apigee_v1_data_collector_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollector
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of API proxies or shared flows.
# @param [String] parent
# Required. Name of the organization for which to return deployment information
# in the following format: `organizations/`org``
# @param [Boolean] shared_flows
# Optional. Flag that specifies whether to return shared flow or API proxy
# deployments. Set to `true` to return shared flow deployments; set to `false`
# to return API proxy deployments. Defaults to `false`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_deployments(parent, shared_flows: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['sharedFlows'] = shared_flows unless shared_flows.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates developer attributes. This API replaces the existing attributes with
# those specified in the request. Add new attributes, and include or exclude any
# existing attributes that you want to retain or remove, respectively. The
# custom attribute limit is 18. **Note**: OAuth access tokens and Key Management
# Service (KMS) entities (apps, developers, and API products) are cached for 180
# seconds (default). Any custom attributes associated with these entities are
# cached for at least 180 seconds after the entity is accessed at runtime.
# Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to
# expire an access token in less than 180 seconds.
# @param [String] parent
# Required. Email address of the developer for which attributes are being
# updated in the following format: `organizations/`org`/developers/`
# developer_email``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def attributes_organization_developer(parent, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/attributes', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
command.request_object = google_cloud_apigee_v1_attributes_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a developer. Once created, the developer can register an app and
# obtain an API key. At creation time, a developer is set as `active`. To change
# the developer status, use the SetDeveloperStatus API.
# @param [String] parent
# Required. Name of the Apigee organization in which the developer is created.
# Use the following structure in your request: `organizations/`org``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] google_cloud_apigee_v1_developer_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_developer(parent, google_cloud_apigee_v1_developer_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/developers', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
command.request_object = google_cloud_apigee_v1_developer_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a developer. All apps and API keys associated with the developer are
# also removed. **Warning**: This API will permanently delete the developer and
# related artifacts. To avoid permanently deleting developers and their
# artifacts, set the developer status to `inactive` using the SetDeveloperStatus
# API. **Note**: The delete operation is asynchronous. The developer app is
# deleted immediately, but its associated resources, such as apps and API keys,
# may take anywhere from a few seconds to a few minutes to be deleted.
# @param [String] name
# Required. Email address of the developer. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_developer(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the developer details, including the developer's name, email address,
# apps, and other information. **Note**: The response includes only the first
# 100 developer apps.
# @param [String] name
# Required. Email address of the developer. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email``
# @param [String] action
# Status of the developer. Valid values are `active` or `inactive`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_developer(name, action: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer
command.params['name'] = name unless name.nil?
command.query['action'] = action unless action.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all developers in an organization by email address. By default, the
# response does not include company developers. Set the `includeCompany` query
# parameter to `true` to include company developers. **Note**: A maximum of 1000
# developers are returned in the response. You paginate the list of developers
# returned using the `startKey` and `count` query parameters.
# @param [String] parent
# Required. Name of the Apigee organization. Use the following structure in your
# request: `organizations/`org``.
# @param [String] app
# Optional. List only Developers that are associated with the app. Note that
# start_key, count are not applicable for this filter criteria.
# @param [Fixnum] count
# Optional. Number of developers to return in the API call. Use with the `
# startKey` parameter to provide more targeted filtering. The limit is 1000.
# @param [Boolean] expand
# Specifies whether to expand the results. Set to `true` to expand the results.
# This query parameter is not valid if you use the `count` or `startKey` query
# parameters.
# @param [String] ids
# Optional. List of IDs to include, separated by commas.
# @param [Boolean] include_company
# Flag that specifies whether to include company details in the response.
# @param [String] start_key
# **Note**: Must be used in conjunction with the `count` parameter. Email
# address of the developer from which to start displaying the list of developers.
# For example, if the an unfiltered list returns: ``` westley@example.com
# fezzik@example.com buttercup@example.com ``` and your `startKey` is `fezzik@
# example.com`, the list returned will be ``` fezzik@example.com buttercup@
# example.com ```
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_developers(parent, app: nil, count: nil, expand: nil, ids: nil, include_company: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/developers', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListOfDevelopersResponse
command.params['parent'] = parent unless parent.nil?
command.query['app'] = app unless app.nil?
command.query['count'] = count unless count.nil?
command.query['expand'] = expand unless expand.nil?
command.query['ids'] = ids unless ids.nil?
command.query['includeCompany'] = include_company unless include_company.nil?
command.query['startKey'] = start_key unless start_key.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the status of a developer. Valid values are `active` or `inactive`. A
# developer is `active` by default. If you set a developer's status to `inactive`
# , the API keys assigned to the developer apps are no longer valid even though
# the API keys are set to `approved`. Inactive developers can still sign in to
# the developer portal and create apps; however, any new API keys generated
# during app creation won't work. If successful, the API call returns the
# following HTTP status code: `204 No Content`
# @param [String] name
# Required. Email address of the developer. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email``
# @param [String] action
# Status of the developer. Valid values are `active` and `inactive`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_organization_developer_developer_status(name, action: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['action'] = action unless action.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a developer. This API replaces the existing developer details with
# those specified in the request. Include or exclude any existing details that
# you want to retain or delete, respectively. The custom attribute limit is 18. *
# *Note**: OAuth access tokens and Key Management Service (KMS) entities (apps,
# developers, and API products) are cached for 180 seconds (current default).
# Any custom attributes associated with these entities are cached for at least
# 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn`
# element on the OAuthV2 policy won't be able to expire an access token in less
# than 180 seconds.
# @param [String] name
# Required. Email address of the developer. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] google_cloud_apigee_v1_developer_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_developer(name, google_cloud_apigee_v1_developer_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
command.request_object = google_cloud_apigee_v1_developer_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates attributes for a developer app. This API replaces the current
# attributes with those specified in the request.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def attributes_organization_developer_app(name, google_cloud_apigee_v1_attributes_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}/attributes', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
command.request_object = google_cloud_apigee_v1_attributes_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an app associated with a developer. This API associates the developer
# app with the specified API product and auto-generates an API key for the app
# to use in calls to API proxies inside that API product. The `name` is the
# unique ID of the app that you can use in API calls. The `DisplayName` (set as
# an attribute) appears in the UI. If you don't set the `DisplayName` attribute,
# the `name` appears in the UI.
# @param [String] parent
# Required. Name of the developer. Use the following structure in your request: `
# organizations/`org`/developers/`developer_email``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_developer_app(parent, google_cloud_apigee_v1_developer_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/apps', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
command.request_object = google_cloud_apigee_v1_developer_app_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a developer app. **Note**: The delete operation is asynchronous. The
# developer app is deleted immediately, but its associated resources, such as
# app keys or access tokens, may take anywhere from a few seconds to a few
# minutes to be deleted.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_developer_app(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Manages access to a developer app by enabling you to: * Approve or revoke a
# developer app * Generate a new consumer key and secret for a developer app To
# approve or revoke a developer app, set the `action` query parameter to `
# approved` or `revoked`, respectively, and the `Content-Type` header to `
# application/octet-stream`. If a developer app is revoked, none of its API keys
# are valid for API calls even though the keys are still `approved`. If
# successful, the API call returns the following HTTP status code: `204 No
# Content` To generate a new consumer key and secret for a developer app, pass
# the new key/secret details. Rather than replace an existing key, this API
# generates a new key. In this case, multiple key pairs may be associated with a
# single developer app. Each key pair has an independent status (`approved` or `
# revoked`) and expiration time. Any approved, non-expired key can be used in an
# API call. For example, if you're using API key rotation, you can generate new
# keys with expiration times that overlap keys that are going to expire. You
# might also generate a new consumer key/secret if the security of the original
# key/secret is compromised. The `keyExpiresIn` property defines the expiration
# time for the API key in milliseconds. If you don't set this property or set it
# to `-1`, the API key never expires. **Notes**: * When generating a new key/
# secret, this API replaces the existing attributes, notes, and callback URLs
# with those specified in the request. Include or exclude any existing
# information that you want to retain or delete, respectively. * To migrate
# existing consumer keys and secrets to hybrid from another system, see the
# CreateDeveloperAppKey API.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object
# @param [String] action
# Action. Valid values are `approve` or `revoke`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def generate_organization_developer_app_key_pair_or_update_developer_app_status(name, google_cloud_apigee_v1_developer_app_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
command.request_object = google_cloud_apigee_v1_developer_app_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
command.params['name'] = name unless name.nil?
command.query['action'] = action unless action.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the details for a developer app.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [String] entity
# **Note**: Must be used in conjunction with the `query` parameter. Set to `
# apiresources` to return the number of API resources that have been approved
# for access by a developer app in the specified Apigee organization.
# @param [String] query
# **Note**: Must be used in conjunction with the `entity` parameter. Set to `
# count` to return the number of API resources that have been approved for
# access by a developer app in the specified Apigee organization.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_developer_app(name, entity: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
command.params['name'] = name unless name.nil?
command.query['entity'] = entity unless entity.nil?
command.query['query'] = query unless query.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all apps created by a developer in an Apigee organization. Optionally,
# you can request an expanded view of the developer apps. A maximum of 100
# developer apps are returned per API call. You can paginate the list of
# deveoper apps returned using the `startKey` and `count` query parameters.
# @param [String] parent
# Required. Name of the developer. Use the following structure in your request: `
# organizations/`org`/developers/`developer_email``
# @param [Fixnum] count
# Number of developer apps to return in the API call. Use with the `startKey`
# parameter to provide more targeted filtering. The limit is 1000.
# @param [Boolean] expand
# Optional. Specifies whether to expand the results. Set to `true` to expand the
# results. This query parameter is not valid if you use the `count` or `startKey`
# query parameters.
# @param [Boolean] shallow_expand
# Optional. Specifies whether to expand the results in shallow mode. Set to `
# true` to expand the results in shallow mode.
# @param [String] start_key
# **Note**: Must be used in conjunction with the `count` parameter. Name of the
# developer app from which to start displaying the list of developer apps. For
# example, if you're returning 50 developer apps at a time (using the `count`
# query parameter), you can view developer apps 50-99 by entering the name of
# the 50th developer app. The developer app name is case sensitive.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_developer_apps(parent, count: nil, expand: nil, shallow_expand: nil, start_key: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/apps', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeveloperAppsResponse
command.params['parent'] = parent unless parent.nil?
command.query['count'] = count unless count.nil?
command.query['expand'] = expand unless expand.nil?
command.query['shallowExpand'] = shallow_expand unless shallow_expand.nil?
command.query['startKey'] = start_key unless start_key.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the details for a developer app. In addition, you can add an API
# product to a developer app and automatically generate an API key for the app
# to use when calling APIs in the API product. If you want to use an existing
# API key for the API product, add the API product to the API key using the
# UpdateDeveloperAppKey API. Using this API, you cannot update the following: *
# App name as it is the primary key used to identify the app and cannot be
# changed. * Scopes associated with the app. Instead, use the
# ReplaceDeveloperAppKey API. This API replaces the existing attributes with
# those specified in the request. Include or exclude any existing attributes
# that you want to retain or delete, respectively.
# @param [String] name
# Required. Name of the developer app. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_developer_app(name, google_cloud_apigee_v1_developer_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
command.request_object = google_cloud_apigee_v1_developer_app_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a developer app attribute.
# @param [String] name
# Required. Name of the developer app attribute. Use the following structure in
# your request: `organizations/`org`/developers/`developer_email`/apps/`app`/
# attributes/`attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_developer_app_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a developer app attribute.
# @param [String] name
# Required. Name of the developer app attribute. Use the following structure in
# your request: `organizations/`org`/developers/`developer_email`/apps/`app`/
# attributes/`attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_developer_app_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a list of all developer app attributes.
# @param [String] parent
# Required. Name of the developer app. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email`/apps/`app``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_developer_app_attributes(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/attributes', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a developer app attribute. **Note**: OAuth access tokens and Key
# Management Service (KMS) entities (apps, developers, and API products) are
# cached for 180 seconds (current default). Any custom attributes associated
# with these entities are cached for at least 180 seconds after the entity is
# accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy
# won't be able to expire an access token in less than 180 seconds.
# @param [String] name
# Required. Name of the developer app attribute. Use the following structure in
# your request: `organizations/`org`/developers/`developer_email`/apps/`app`/
# attributes/`attribute``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_developer_app_attribute_developer_app_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.request_object = google_cloud_apigee_v1_attribute_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a custom consumer key and secret for a developer app. This is
# particularly useful if you want to migrate existing consumer keys and secrets
# to Apigee hybrid from another system. Consumer keys and secrets can contain
# letters, numbers, underscores, and hyphens. No other special characters are
# allowed. To avoid service disruptions, a consumer key and secret should not
# exceed 2 KBs each. **Note**: When creating the consumer key and secret, an
# association to API products will not be made. Therefore, you should not
# specify the associated API products in your request. Instead, use the
# UpdateDeveloperAppKey API to make the association after the consumer key and
# secret are created. If a consumer key and secret already exist, you can keep
# them or delete them using the DeleteDeveloperAppKey API.
# @param [String] parent
# Parent of the developer app key. Use the following structure in your request: `
# organizations/`org`/developers/`developer_email`/apps`
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_developer_app_key(parent, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/keys', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.request_object = google_cloud_apigee_v1_developer_app_key_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an app's consumer key and removes all API products associated with the
# app. After the consumer key is deleted, it cannot be used to access any APIs. *
# *Note**: After you delete a consumer key, you may want to: 1. Create a new
# consumer key and secret for the developer app using the CreateDeveloperAppKey
# API, and subsequently add an API product to the key using the
# UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer
# required.
# @param [String] name
# Name of the developer app key. Use the following structure in your request: `
# organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_developer_app_key(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns details for a consumer key for a developer app, including the key and
# secret value, associated API products, and other information.
# @param [String] name
# Name of the developer app key. Use the following structure in your request: `
# organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_developer_app_key(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the scope of an app. This API replaces the existing scopes with those
# specified in the request. Include or exclude any existing scopes that you want
# to retain or delete, respectively. The specified scopes must already be
# defined for the API products associated with the app. This API sets the `
# scopes` element under the `apiProducts` element in the attributes of the app.
# @param [String] name
# Name of the developer app key. Use the following structure in your request: `
# organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def replace_organization_developer_app_key_developer_app_key(name, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.request_object = google_cloud_apigee_v1_developer_app_key_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Adds an API product to a developer app key, enabling the app that holds the
# key to access the API resources bundled in the API product. In addition, you
# can add attributes to a developer app key. This API replaces the existing
# attributes with those specified in the request. Include or exclude any
# existing attributes that you want to retain or delete, respectively. You can
# use the same key to access all API products associated with the app.
# @param [String] name
# Name of the developer app key. Use the following structure in your request: `
# organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object
# @param [String] action
# Approve or revoke the consumer key by setting this value to `approve` or `
# revoke`, respectively.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_developer_app_key_developer_app_key(name, google_cloud_apigee_v1_developer_app_key_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.request_object = google_cloud_apigee_v1_developer_app_key_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
command.params['name'] = name unless name.nil?
command.query['action'] = action unless action.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Removes an API product from an app's consumer key. After the API product is
# removed, the app cannot access the API resources defined in that API product. *
# *Note**: The consumer key is not removed, only its association with the API
# product.
# @param [String] name
# Name of the API product in the developer app key in the following format: `
# organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`/
# apiproducts/`apiproduct``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_developer_app_key_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Approve or revoke an app's consumer key. After a consumer key is approved, the
# app can use it to access APIs. A consumer key that is revoked or pending
# cannot be used to access an API. Any access tokens associated with a revoked
# consumer key will remain active. However, Apigee hybrid checks the status of
# the consumer key and if set to `revoked` will not allow access to the API.
# @param [String] name
# Name of the API product in the developer app key in the following format: `
# organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`/
# apiproducts/`apiproduct``
# @param [String] action
# Approve or revoke the consumer key by setting this value to `approve` or `
# revoke`, respectively.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_developer_app_key_apiproduct_developer_app_key_api_product(name, action: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['action'] = action unless action.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a custom consumer key and secret for a developer app. This is
# particularly useful if you want to migrate existing consumer keys and secrets
# to Apigee hybrid from another system. Consumer keys and secrets can contain
# letters, numbers, underscores, and hyphens. No other special characters are
# allowed. To avoid service disruptions, a consumer key and secret should not
# exceed 2 KBs each. **Note**: When creating the consumer key and secret, an
# association to API products will not be made. Therefore, you should not
# specify the associated API products in your request. Instead, use the
# UpdateDeveloperAppKey API to make the association after the consumer key and
# secret are created. If a consumer key and secret already exist, you can keep
# them or delete them using the DeleteDeveloperAppKey API.
# @param [String] parent
# Parent of the developer app key. Use the following structure in your request: `
# organizations/`org`/developers/`developer_email`/apps`
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_developer_app_key_create(parent, google_cloud_apigee_v1_developer_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/keys/create', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.request_object = google_cloud_apigee_v1_developer_app_key_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a developer attribute.
# @param [String] name
# Required. Name of the developer attribute. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email`/attributes/`
# attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_developer_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the value of the specified developer attribute.
# @param [String] name
# Required. Name of the developer attribute. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email`/attributes/`
# attribute``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_developer_attribute(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns a list of all developer attributes.
# @param [String] parent
# Required. Email address of the developer for which attributes are being listed
# in the following format: `organizations/`org`/developers/`developer_email``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_developer_attributes(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/attributes', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a developer attribute. **Note**: OAuth access tokens and Key
# Management Service (KMS) entities (apps, developers, and API products) are
# cached for 180 seconds (default). Any custom attributes associated with these
# entities are cached for at least 180 seconds after the entity is accessed at
# runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able
# to expire an access token in less than 180 seconds.
# @param [String] name
# Required. Name of the developer attribute. Use the following structure in your
# request: `organizations/`org`/developers/`developer_email`/attributes/`
# attribute``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_developer_attribute_developer_attribute(name, google_cloud_apigee_v1_attribute_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.request_object = google_cloud_apigee_v1_attribute_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new environment group.
# @param [String] parent
# Required. Name of the organization in which to create the environment group in
# the following format: `organizations/`org``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup] google_cloud_apigee_v1_environment_group_object
# @param [String] name
# ID of the environment group. Overrides any ID in the environment_group
# resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_envgroup(parent, google_cloud_apigee_v1_environment_group_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/envgroups', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup::Representation
command.request_object = google_cloud_apigee_v1_environment_group_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an environment group.
# @param [String] name
# Required. Name of the environment group in the following format: `
# organizations/`org`/envgroups/`envgroup``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_envgroup(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets an environment group.
# @param [String] name
# Required. Name of the environment group in the following format: `
# organizations/`org`/envgroups/`envgroup``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_envgroup(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all environment groups.
# @param [String] parent
# Required. Name of the organization for which to list environment groups in the
# following format: `organizations/`org``.
# @param [Fixnum] page_size
# Maximum number of environment groups to return. The page size defaults to 25.
# @param [String] page_token
# Page token, returned from a previous ListEnvironmentGroups call, that you can
# use to retrieve the next page.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_envgroups(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/envgroups', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an environment group.
# @param [String] name
# Required. Name of the environment group to update in the format: `
# organizations/`org`/envgroups/`envgroup`.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup] google_cloud_apigee_v1_environment_group_object
# @param [String] update_mask
# List of fields to be updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_organization_envgroup(name, google_cloud_apigee_v1_environment_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup::Representation
command.request_object = google_cloud_apigee_v1_environment_group_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new attachment of an environment to an environment group.
# @param [String] parent
# Required. EnvironmentGroup under which to create the attachment in the
# following format: `organizations/`org`/envgroups/`envgroup``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment] google_cloud_apigee_v1_environment_group_attachment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_envgroup_attachment(parent, google_cloud_apigee_v1_environment_group_attachment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/attachments', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment::Representation
command.request_object = google_cloud_apigee_v1_environment_group_attachment_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an environment group attachment.
# @param [String] name
# Required. Name of the environment group attachment to delete in the following
# format: `organizations/`org`/envgroups/`envgroup`/attachments/`attachment``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_envgroup_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets an environment group attachment.
# @param [String] name
# Required. Name of the environment group attachment in the following format: `
# organizations/`org`/envgroups/`envgroup`/attachments/`attachment``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_envgroup_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all attachments of an environment group.
# @param [String] parent
# Required. Name of the environment group in the following format: `
# organizations/`org`/envgroups/`envgroup``.
# @param [Fixnum] page_size
# Maximum number of environment group attachments to return. The page size
# defaults to 25.
# @param [String] page_token
# Page token, returned by a previous ListEnvironmentGroupAttachments call, that
# you can use to retrieve the next page.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_envgroup_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/attachments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an environment in an organization.
# @param [String] parent
# Required. Name of the organization in which the environment will be created.
# Use the following structure in your request: `organizations/`org``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object
# @param [String] name
# Optional. Name of the environment. Alternatively, the name may be specified in
# the request body in the name field.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment(parent, google_cloud_apigee_v1_environment_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/environments', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
command.request_object = google_cloud_apigee_v1_environment_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an environment from an organization.
# @param [String] name
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_environment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets environment details.
# @param [String] name
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the debug mask singleton resource for an environment.
# @param [String] name
# Required. Name of the debug mask. Use the following structure in your request:
# `organizations/`org`/environments/`env`/debugmask`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_debugmask(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the deployed configuration for an environment.
# @param [String] name
# Required. Name of the environment deployed configuration resource. Use the
# following structure in your request: `organizations/`org`/environments/`env`/
# deployedConfig`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_deployed_config(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the IAM policy on an environment. For more information, see [Manage users,
# roles, and permissions using the API](https://cloud.google.com/apigee/docs/
# api-platform/system-administration/manage-users-roles). You must have the `
# apigee.environments.getIamPolicy` permission to call this API.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The policy format version to be returned. Valid values are 0, 1, and
# 3. Requests specifying an invalid value will be rejected. Requests for
# policies with any conditional bindings must specify version 3. Policies
# without any conditional bindings may specify any valid value or leave the
# field unset. To learn which resources support conditions in their IAM policies,
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
# resource-policies).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the IAM policy on an environment, if the policy already exists it will be
# replaced. For more information, see [Manage users, roles, and permissions
# using the API](https://cloud.google.com/apigee/docs/api-platform/system-
# administration/manage-users-roles). You must have the `apigee.environments.
# setIamPolicy` permission to call this API.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::ApigeeV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleIamV1Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleIamV1Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_organization_environment_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleIamV1SetIamPolicyRequest::Representation
command.request_object = google_iam_v1_set_iam_policy_request_object
command.response_representation = Google::Apis::ApigeeV1::GoogleIamV1Policy::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleIamV1Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a subscription for the environment's Pub/Sub topic. The server will
# assign a random name for this subscription. The "name" and "push_config" must *
# not* be specified.
# @param [String] parent
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def subscribe_organization_environment(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}:subscribe', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Tests the permissions of a user on an environment, and returns a subset of
# permissions that the user has on the environment. If the environment does not
# exist, an empty permission set is returned (a NOT_FOUND error is not returned).
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_organization_environment_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsRequest::Representation
command.request_object = google_iam_v1_test_iam_permissions_request_object
command.response_representation = Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleIamV1TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a subscription for the environment's Pub/Sub topic.
# @param [String] parent
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription] google_cloud_apigee_v1_subscription_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def unsubscribe_organization_environment(parent, google_cloud_apigee_v1_subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}:unsubscribe', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Subscription::Representation
command.request_object = google_cloud_apigee_v1_subscription_object
command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an existing environment. When updating properties, you must pass all
# existing properties to the API, even if they are not being changed. If you
# omit properties from the payload, the properties are removed. To get the
# current list of properties for the environment, use the [Get Environment API](
# get).
# @param [String] name
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_environment(name, google_cloud_apigee_v1_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
command.request_object = google_cloud_apigee_v1_environment_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the debug mask singleton resource for an environment.
# @param [String] name
# Name of the debug mask.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] google_cloud_apigee_v1_debug_mask_object
# @param [Boolean] replace_repeated_fields
# Boolean flag that specifies whether to replace existing values in the debug
# mask when doing an update. Set to true to replace existing values. The default
# behavior is to append the values (false).
# @param [String] update_mask
# Field debug mask to support partial updates.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_environment_debugmask(name, google_cloud_apigee_v1_debug_mask_object = nil, replace_repeated_fields: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation
command.request_object = google_cloud_apigee_v1_debug_mask_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask
command.params['name'] = name unless name.nil?
command.query['replaceRepeatedFields'] = replace_repeated_fields unless replace_repeated_fields.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an existing environment. When updating properties, you must pass all
# existing properties to the API, even if they are not being changed. If you
# omit properties from the payload, the properties are removed. To get the
# current list of properties for the environment, use the [Get Environment API](
# get).
# @param [String] name
# Required. Name of the environment. Use the following structure in your request:
# `organizations/`org`/environments/`env``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_environment_environment(name, google_cloud_apigee_v1_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
command.request_object = google_cloud_apigee_v1_environment_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a list of metrics and dimensions which can be used for creating analytics
# queries and reports. Each schema element contains the name of the field with
# its associated type and if it is either custom field or standard field.
# @param [String] name
# Required. The parent organization and environment names. Must be of the form `
# organizations/`org`/environments/`env`/analytics/admin/schemav2`.
# @param [String] type
# Required. Type refers to the dataset name whose schema needs to be retrieved E.
# g. type=fact or type=agg_cus1
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_analytic_admin_schemav2(name, type: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Schema
command.params['name'] = name unless name.nil?
command.query['type'] = type unless type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Submit a data export job to be processed in the background. If the request is
# successful, the API returns a 201 status, a URI that can be used to retrieve
# the status of the export job, and the `state` value of "enqueued".
# @param [String] parent
# Required. Names of the parent organization and environment. Must be of the
# form `organizations/`org`/environments/`env``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExportRequest] google_cloud_apigee_v1_export_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment_analytic_export(parent, google_cloud_apigee_v1_export_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/analytics/exports', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExportRequest::Representation
command.request_object = google_cloud_apigee_v1_export_request_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the details and status of an analytics export job. If the export job is
# still in progress, its `state` is set to "running". After the export job has
# completed successfully, its `state` is set to "completed". If the export job
# fails, its `state` is set to `failed`.
# @param [String] name
# Required. Resource name of the export to get.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_analytic_export(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Export
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the details and status of all analytics export jobs belonging to the
# parent organization and environment.
# @param [String] parent
# Required. Names of the parent organization and environment. Must be of the
# form `organizations/`org`/environments/`env``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListExportsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListExportsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_environment_analytic_exports(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/analytics/exports', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListExportsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListExportsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of an API proxy in an environment.
# @param [String] parent
# Required. Name representing an API proxy in an environment in the following
# format: `organizations/`org`/environments/`env`/apis/`api``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_environment_api_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deploys a revision of an API proxy. If another revision of the same API proxy
# revision is currently deployed, set the `override` parameter to `true` to have
# this revision replace the currently deployed revision. You cannot invoke an
# API proxy until it has been deployed to an environment. After you deploy an
# API proxy revision, you cannot edit it. To edit the API proxy, you must create
# and deploy a new revision. For a request path `organizations/`org`/
# environments/`env`/apis/`api`/revisions/`rev`/deployments`, two permissions
# are required: * `apigee.deployments.create` on the resource `organizations/`
# org`/environments/`env`` * `apigee.proxyrevisions.deploy` on the resource `
# organizations/`org`/apis/`api`/revisions/`rev``
# @param [String] name
# Required. Name of the API proxy revision deployment in the following format: `
# organizations/`org`/environments/`env`/apis/`api`/revisions/`rev``
# @param [Boolean] override
# Flag that specifies whether the new deployment replaces other deployed
# revisions of the API proxy in the environment. Set override to true to replace
# other deployed revisions. By default, override is false and the deployment is
# rejected if other revisions of the API proxy are deployed in the environment.
# @param [Boolean] sequenced_rollout
# If true, a best-effort attempt will be made to roll out the routing rules
# corresponding to this deployment and the environment changes to add this
# deployment in a safe order. This reduces the risk of downtime that could be
# caused by changing the environment group's routing before the new destination
# for the affected traffic is ready to receive it. This should only be necessary
# if the new deployment will be capturing traffic from another environment under
# a shared environment group or if traffic will be rerouted to a different
# environment due to a basepath removal. The GenerateDeployChangeReport API may
# be used to examine routing changes before issuing the deployment request, and
# its response will indicate if a sequenced rollout is recommended for the
# deployment.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def deploy_organization_environment_api_revision(name, override: nil, sequenced_rollout: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment
command.params['name'] = name unless name.nil?
command.query['override'] = override unless override.nil?
command.query['sequencedRollout'] = sequenced_rollout unless sequenced_rollout.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the deployment of an API proxy revision and actual state reported by
# runtime pods.
# @param [String] name
# Required. Name representing an API proxy revision in an environment in the
# following format: `organizations/`org`/environments/`env`/apis/`api`/revisions/
# `rev``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_api_revision_deployments(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Undeploys an API proxy revision from an environment. For a request path `
# organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`/deployments`,
# two permissions are required: * `apigee.deployments.delete` on the resource `
# organizations/`org`/environments/`env`` * `apigee.proxyrevisions.undeploy` on
# the resource `organizations/`org`/apis/`api`/revisions/`rev``
# @param [String] name
# Required. Name of the API proxy revision deployment in the following format: `
# organizations/`org`/environments/`env`/apis/`api`/revisions/`rev``
# @param [Boolean] sequenced_rollout
# If true, a best-effort attempt will be made to remove the environment group
# routing rules corresponding to this deployment before removing the deployment
# from the runtime. This is likely to be a rare use case; it is only needed when
# the intended effect of undeploying this proxy is to cause the traffic it
# currently handles to be rerouted to some other existing proxy in the
# environment group. The GenerateUndeployChangeReport API may be used to examine
# routing changes before issuing the undeployment request, and its response will
# indicate if a sequenced rollout is recommended for the undeployment.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def undeploy_organization_environment_api_revision(name, sequenced_rollout: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['sequencedRollout'] = sequenced_rollout unless sequenced_rollout.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a debug session for a deployed API Proxy revision.
# @param [String] parent
# Required. The resource name of the API Proxy revision deployment for which to
# create the DebugSession. Must be of the form `organizations/`organization`/
# environments/`environment`/apis/`api`/revisions/`revision``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] google_cloud_apigee_v1_debug_session_object
# @param [Fixnum] timeout
# Optional. The time in seconds after which this DebugSession should end. A
# timeout specified in DebugSession will overwrite this value.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment_api_revision_debugsession(parent, google_cloud_apigee_v1_debug_session_object = nil, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/debugsessions', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession::Representation
command.request_object = google_cloud_apigee_v1_debug_session_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession
command.params['parent'] = parent unless parent.nil?
command.query['timeout'] = timeout unless timeout.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the data from a debug session. This does not cancel the debug session
# or prevent further data from being collected if the session is still active in
# runtime pods.
# @param [String] name
# Required. The name of the debug session to delete. Must be of the form: `
# organizations/`organization`/environments/`environment`/apis/`api`/revisions/`
# revision`/debugsessions/`debugsession``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_environment_api_revision_debugsession_data(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}/data', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves a debug session.
# @param [String] name
# Required. The name of the debug session to retrieve. Must be of the form: `
# organizations/`organization`/environments/`environment`/apis/`api`/revisions/`
# revision`/debugsessions/`session``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_api_revision_debugsession(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists debug sessions that are currently active in the given API Proxy revision.
# @param [String] parent
# Required. The name of the API Proxy revision deployment for which to list
# debug sessions. Must be of the form: `organizations/`organization`/
# environments/`environment`/apis/`api`/revisions/`revision``.
# @param [Fixnum] page_size
# Maximum number of debug sessions to return. The page size defaults to 25.
# @param [String] page_token
# Page token, returned from a previous ListDebugSessions call, that you can use
# to retrieve the next page.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_environment_api_revision_debugsessions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/debugsessions', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDebugSessionsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the debug data from a transaction.
# @param [String] name
# Required. The name of the debug session transaction. Must be of the form: `
# organizations/`organization`/environments/`environment`/apis/`api`/revisions/`
# revision`/debugsessions/`session`/data/`transaction``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_api_revision_debugsession_datum(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSessionTransaction
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Generates a report for a dry run analysis of a DeployApiProxy request without
# committing the deployment. In addition to the standard validations performed
# when adding deployments, additional analysis will be done to detect possible
# traffic routing changes that would result from this deployment being created.
# Any potential routing conflicts or unsafe changes will be reported in the
# response. This routing analysis is not performed for a non-dry-run
# DeployApiProxy request. For a request path `organizations/`org`/environments/`
# env`/apis/`api`/revisions/`rev`/deployments:generateDeployChangeReport`, two
# permissions are required: * `apigee.deployments.create` on the resource `
# organizations/`org`/environments/`env`` * `apigee.proxyrevisions.deploy` on
# the resource `organizations/`org`/apis/`api`/revisions/`rev``
# @param [String] name
# Name of the API proxy revision deployment in the following format: `
# organizations/`org`/environments/`env`/apis/`api`/revisions/`rev``
# @param [Boolean] override
# Flag that specifies whether to force the deployment of the new revision over
# the currently deployed revision by overriding conflict checks.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def generate_organization_environment_api_revision_deployment_deploy_change_report(name, override: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}/deployments:generateDeployChangeReport', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport
command.params['name'] = name unless name.nil?
command.query['override'] = override unless override.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Generates a report for a dry run analysis of an UndeployApiProxy request
# without committing the undeploy. In addition to the standard validations
# performed when removing deployments, additional analysis will be done to
# detect possible traffic routing changes that would result from this deployment
# being removed. Any potential routing conflicts or unsafe changes will be
# reported in the response. This routing analysis is not performed for a non-dry-
# run UndeployApiProxy request. For a request path `organizations/`org`/
# environments/`env`/apis/`api`/revisions/`rev`/deployments:
# generateUndeployChangeReport`, two permissions are required: * `apigee.
# deployments.delete` on the resource `organizations/`org`/environments/`env`` *
# `apigee.proxyrevisions.undeploy` on the resource `organizations/`org`/apis/`
# api`/revisions/`rev``
# @param [String] name
# Name of the API proxy revision deployment in the following format: `
# organizations/`org`/environments/`env`/apis/`api`/revisions/`rev``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def generate_organization_environment_api_revision_deployment_undeploy_change_report(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}/deployments:generateUndeployChangeReport', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReport
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a cache.
# @param [String] name
# Required. Cache resource name of the form: `organizations/`organization_id`/
# environments/`environment_id`/caches/`cache_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_environment_cach(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of API proxies or shared flows in an environment.
# @param [String] parent
# Required. Name of the environment for which to return deployment information
# in the following format: `organizations/`org`/environments/`env``
# @param [Boolean] shared_flows
# Optional. Flag that specifies whether to return shared flow or API proxy
# deployments. Set to `true` to return shared flow deployments; set to `false`
# to return API proxy deployments. Defaults to `false`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_environment_deployments(parent, shared_flows: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['sharedFlows'] = shared_flows unless shared_flows.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Attaches a shared flow to a flow hook.
# @param [String] name
# Required. Name of the flow hook to which the shared flow should be attached in
# the following format: `organizations/`org`/environments/`env`/flowhooks/`
# flowhook``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] google_cloud_apigee_v1_flow_hook_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def attach_organization_environment_flowhook_shared_flow_to_flow_hook(name, google_cloud_apigee_v1_flow_hook_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation
command.request_object = google_cloud_apigee_v1_flow_hook_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Detaches a shared flow from a flow hook.
# @param [String] name
# Required. Name of the flow hook to detach in the following format: `
# organizations/`org`/environments/`env`/flowhooks/`flowhook``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def detach_organization_environment_flowhook_shared_flow_from_flow_hook(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the name of the shared flow attached to the specified flow hook. If
# there's no shared flow attached to the flow hook, the API does not return an
# error; it simply does not return a name in the response.
# @param [String] name
# Required. Name of the flow hook in the following format: `organizations/`org`/
# environments/`env`/flowhooks/`flowhook``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_flowhook(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a keystore or truststore. - Keystore: Contains certificates and their
# associated keys. - Truststore: Contains trusted certificates used to validate
# a server's certificate. These certificates are typically self-signed
# certificates or certificates that are not signed by a trusted CA.
# @param [String] parent
# Required. Name of the environment in which to create the keystore. Use the
# following format in your request: `organizations/`org`/environments/`env``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] google_cloud_apigee_v1_keystore_object
# @param [String] name
# Optional. Name of the keystore. Overrides the value in Keystore.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment_keystore(parent, google_cloud_apigee_v1_keystore_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/keystores', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation
command.request_object = google_cloud_apigee_v1_keystore_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore
command.params['parent'] = parent unless parent.nil?
command.query['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a keystore or truststore.
# @param [String] name
# Required. Name of the keystore. Use the following format in your request: `
# organizations/`org`/environments/`env`/keystores/`keystore``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_environment_keystore(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a keystore or truststore.
# @param [String] name
# Required. Name of the keystore. Use the following format in your request: `
# organizations/`org`/environments/`env`/keystores/`keystore``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_keystore(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an alias from a key/certificate pair. The structure of the request is
# controlled by the `format` query parameter: - `keycertfile` - Separate PEM-
# encoded key and certificate files are uploaded. Set `Content-Type: multipart/
# form-data` and include the `keyFile`, `certFile`, and `password` (if keys are
# encrypted) fields in the request body. If uploading to a truststore, omit `
# keyFile`. - `pkcs12` - A PKCS12 file is uploaded. Set `Content-Type: multipart/
# form-data`, provide the file in the `file` field, and include the `password`
# field if the file is encrypted in the request body. - `selfsignedcert` - A new
# private key and certificate are generated. Set `Content-Type: application/json`
# and include CertificateGenerationSpec in the request body.
# @param [String] parent
# Required. Name of the keystore. Use the following format in your request: `
# organizations/`org`/environments/`env`/keystores/`keystore``.
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [String] _password
# DEPRECATED: For improved security, specify the password in the request body
# instead of using the query parameter. To specify the password in the request
# body, set `Content-type: multipart/form-data` part with name `password`.
# Password for the private key file, if required.
# @param [String] alias_
# Alias for the key/certificate pair. Values must match the regular expression `[
# \w\s-.]`1,255``. This must be provided for all formats except `selfsignedcert`;
# self-signed certs may specify the alias in either this parameter or the JSON
# body.
# @param [String] format
# Required. Format of the data. Valid values include: `selfsignedcert`, `
# keycertfile`, or `pkcs12`
# @param [Boolean] ignore_expiry_validation
# Flag that specifies whether to ignore expiry validation. If set to `true`, no
# expiry validation will be performed.
# @param [Boolean] ignore_newline_validation
# Flag that specifies whether to ignore newline validation. If set to `true`, no
# error is thrown when the file contains a certificate chain with no newline
# between each certificate. Defaults to `false`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment_keystore_alias(parent, google_api_http_body_object = nil, _password: nil, alias_: nil, format: nil, ignore_expiry_validation: nil, ignore_newline_validation: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/aliases', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.request_object = google_api_http_body_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias
command.params['parent'] = parent unless parent.nil?
command.query['_password'] = _password unless _password.nil?
command.query['alias'] = alias_ unless alias_.nil?
command.query['format'] = format unless format.nil?
command.query['ignoreExpiryValidation'] = ignore_expiry_validation unless ignore_expiry_validation.nil?
command.query['ignoreNewlineValidation'] = ignore_newline_validation unless ignore_newline_validation.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Generates a PKCS #10 Certificate Signing Request for the private key in an
# alias.
# @param [String] name
# Required. Name of the alias. Use the following format in your request: `
# organizations/`org`/environments/`env`/keystores/`keystore`/aliases/`alias``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def csr_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/csr', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an alias.
# @param [String] name
# Required. Name of the alias. Use the following format in your request: `
# organizations/`org`/environments/`env`/keystores/`keystore`/aliases/`alias``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets an alias.
# @param [String] name
# Required. Name of the alias. Use the following format in your request: `
# organizations/`org`/environments/`env`/keystores/`keystore`/aliases/`alias``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_keystore_alias(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the certificate from an alias in PEM-encoded form.
# @param [String] name
# Required. Name of the alias. Use the following format in your request: `
# organizations/`org`/environments/`env`/keystores/`keystore`/aliases/`alias``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_keystore_alias_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/certificate', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the certificate in an alias.
# @param [String] name
# Required. Name of the alias. Use the following format in your request: `
# organizations/`org`/environments/`env`/keystores/`keystore`/aliases/`alias``
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [Boolean] ignore_expiry_validation
# Required. Flag that specifies whether to ignore expiry validation. If set to `
# true`, no expiry validation will be performed.
# @param [Boolean] ignore_newline_validation
# Flag that specifies whether to ignore newline validation. If set to `true`, no
# error is thrown when the file contains a certificate chain with no newline
# between each certificate. Defaults to `false`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_environment_keystore_alias(name, google_api_http_body_object = nil, ignore_expiry_validation: nil, ignore_newline_validation: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.request_object = google_api_http_body_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Alias
command.params['name'] = name unless name.nil?
command.query['ignoreExpiryValidation'] = ignore_expiry_validation unless ignore_expiry_validation.nil?
command.query['ignoreNewlineValidation'] = ignore_newline_validation unless ignore_newline_validation.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a key value map in an environment.
# @param [String] parent
# Required. The name of the environment in which to create the key value map.
# Must be of the form `organizations/`organization`/environments/`environment``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/keyvaluemaps', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
command.request_object = google_cloud_apigee_v1_key_value_map_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete a key value map in an environment.
# @param [String] name
# Required. The name of the key value map. Must be of the form `organizations/`
# organization`/environments/`environment`/keyvaluemaps/`keyvaluemap``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_environment_keyvaluemap(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# This api is similar to GetStats except that the response is less verbose. In
# the current scheme, a query parameter _optimized instructs Edge Analytics to
# change the response but since this behavior is not possible with protocol
# buffer and since this parameter is predominantly used by Edge UI, we are
# introducing a separate api.
# @param [String] name
# Required. The resource name for which the interactive query will be executed.
# Must be of the form `organizations/`organization_id`/environments/`
# environment_id/stats/`dimensions`` Dimensions let you view metrics in
# meaningful groupings. E.g. apiproxy, target_host. The value of dimensions
# should be comma separated list as shown below `organizations/`org`/
# environments/`env`/stats/apiproxy,request_verb`
# @param [String] accuracy
# Legacy field: not used anymore.
# @param [String] agg_table
# If customers want to query custom aggregate tables, then this parameter can be
# used to specify the table name. If this parameter is skipped, then Edge Query
# will try to retrieve the data from fact tables which will be expensive.
# @param [String] filter
# Enables drill-down on specific dimension values.
# @param [String] limit
# This parameter is used to limit the number of result items. Default and the
# max value is 14400.
# @param [String] offset
# Use offset with limit to enable pagination of results. For example, to display
# results 11-20, set limit to '10' and offset to '10'.
# @param [Boolean] realtime
# Legacy field: not used anymore.
# @param [String] select
# Required. The select parameter contains a comma separated list of metrics. E.g.
# sum(message_count),sum(error_count)
# @param [Boolean] sonar
# This parameter routes the query to api monitoring service for last hour.
# @param [String] sort
# This parameter specifies if the sort order should be ascending or descending
# Supported values are DESC and ASC.
# @param [String] sortby
# Comma separated list of columns to sort the final result.
# @param [String] time_range
# Required. Time interval for the interactive query. Time range is specified as
# start~end E.g. 04/15/2017 00:00~05/15/2017 23:59
# @param [String] time_unit
# A value of second, minute, hour, day, week, month. Time Unit specifies the
# granularity of metrics returned.
# @param [String] topk
# Take 'top k' results from results, for example, to return the top 5 results '
# topk=5'.
# @param [Boolean] ts_ascending
# Lists timestamps in ascending order if set to true. Recommend setting this
# value to true if you are using sortby with sort=DESC.
# @param [String] tzo
# This parameters contains the timezone offset value.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_optimized_stat(name, accuracy: nil, agg_table: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sonar: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats
command.params['name'] = name unless name.nil?
command.query['accuracy'] = accuracy unless accuracy.nil?
command.query['aggTable'] = agg_table unless agg_table.nil?
command.query['filter'] = filter unless filter.nil?
command.query['limit'] = limit unless limit.nil?
command.query['offset'] = offset unless offset.nil?
command.query['realtime'] = realtime unless realtime.nil?
command.query['select'] = select unless select.nil?
command.query['sonar'] = sonar unless sonar.nil?
command.query['sort'] = sort unless sort.nil?
command.query['sortby'] = sortby unless sortby.nil?
command.query['timeRange'] = time_range unless time_range.nil?
command.query['timeUnit'] = time_unit unless time_unit.nil?
command.query['topk'] = topk unless topk.nil?
command.query['tsAscending'] = ts_ascending unless ts_ascending.nil?
command.query['tzo'] = tzo unless tzo.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Submit a query to be processed in the background. If the submission of the
# query succeeds, the API returns a 201 status and an ID that refer to the query.
# In addition to the HTTP status 201, the `state` of "enqueued" means that the
# request succeeded.
# @param [String] parent
# Required. The parent resource name. Must be of the form `organizations/`org`/
# environments/`env``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query] google_cloud_apigee_v1_query_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment_query(parent, google_cloud_apigee_v1_query_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/queries', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query::Representation
command.request_object = google_cloud_apigee_v1_query_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get query status If the query is still in progress, the `state` is set to "
# running" After the query has completed successfully, `state` is set to "
# completed"
# @param [String] name
# Required. Name of the asynchronous query to get. Must be of the form `
# organizations/`org`/environments/`env`/queries/`queryId``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_query(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# After the query is completed, use this API to retrieve the results. If the
# request succeeds, and there is a non-zero result set, the result is downloaded
# to the client as a zipped JSON file. The name of the downloaded file will be:
# OfflineQueryResult-.zip Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-
# 318d0cb961bd.zip`
# @param [String] name
# Required. Name of the asynchronous query result to get. Must be of the form `
# organizations/`org`/environments/`env`/queries/`queryId`/result`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_query_result(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Return a list of Asynchronous Queries
# @param [String] parent
# Required. The parent resource name. Must be of the form `organizations/`org`/
# environments/`env``.
# @param [String] dataset
# Filter response list by dataset. Example: `api`, `mint`
# @param [String] from
# Filter response list by returning asynchronous queries that created after this
# date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.
# @param [String] incl_queries_without_report
# Flag to include asynchronous queries that don't have a report denifition.
# @param [String] status
# Filter response list by asynchronous query status.
# @param [String] submitted_by
# Filter response list by user who submitted queries.
# @param [String] to
# Filter response list by returning asynchronous queries that created before
# this date time. Time must be in ISO date-time format like '2011-12-03T10:16:
# 30Z'.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_environment_queries(parent, dataset: nil, from: nil, incl_queries_without_report: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/queries', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse
command.params['parent'] = parent unless parent.nil?
command.query['dataset'] = dataset unless dataset.nil?
command.query['from'] = from unless from.nil?
command.query['inclQueriesWithoutReport'] = incl_queries_without_report unless incl_queries_without_report.nil?
command.query['status'] = status unless status.nil?
command.query['submittedBy'] = submitted_by unless submitted_by.nil?
command.query['to'] = to unless to.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a Reference in the specified environment.
# @param [String] parent
# Required. The parent environment name under which the Reference will be
# created. Must be of the form `organizations/`org`/environments/`env``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] google_cloud_apigee_v1_reference_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment_reference(parent, google_cloud_apigee_v1_reference_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/references', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
command.request_object = google_cloud_apigee_v1_reference_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a Reference from an environment. Returns the deleted Reference
# resource.
# @param [String] name
# Required. The name of the Reference to delete. Must be of the form `
# organizations/`org`/environments/`env`/references/`ref``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_environment_reference(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a Reference resource.
# @param [String] name
# Required. The name of the Reference to get. Must be of the form `organizations/
# `org`/environments/`env`/references/`ref``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_reference(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an existing Reference. Note that this operation has PUT semantics; it
# will replace the entirety of the existing Reference with the resource in the
# request body.
# @param [String] name
# Required. The name of the Reference to update. Must be of the form `
# organizations/`org`/environments/`env`/references/`ref``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] google_cloud_apigee_v1_reference_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_environment_reference(name, google_cloud_apigee_v1_reference_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
command.request_object = google_cloud_apigee_v1_reference_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a resource file. Specify the `Content-Type` as `application/octet-
# stream` or `multipart/form-data`. For more information about resource files,
# see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/
# resource-files).
# @param [String] parent
# Required. Name of the environment in which to create the resource file in the
# following format: `organizations/`org`/environments/`env``.
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [String] name
# Required. Name of the resource file. Must match the regular expression: [a-zA-
# Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255`
# @param [String] type
# Required. Resource file type. `` resource_file_type ``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment_resourcefile(parent, google_api_http_body_object = nil, name: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/resourcefiles', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.request_object = google_api_http_body_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile
command.params['parent'] = parent unless parent.nil?
command.query['name'] = name unless name.nil?
command.query['type'] = type unless type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a resource file. For more information about resource files, see [
# Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/
# resource-files).
# @param [String] parent
# Required. Name of the environment in the following format: `organizations/`org`
# /environments/`env``.
# @param [String] type
# Required. Resource file type. `` resource_file_type ``
# @param [String] name
# Required. ID of the resource file to delete. Must match the regular expression:
# [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_environment_resourcefile(parent, type, name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+parent}/resourcefiles/{type}/{name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile
command.params['parent'] = parent unless parent.nil?
command.params['type'] = type unless type.nil?
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the contents of a resource file. For more information about resource
# files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/
# develop/resource-files).
# @param [String] parent
# Required. Name of the environment in the following format: `organizations/`org`
# /environments/`env``.
# @param [String] type
# Required. Resource file type. `` resource_file_type ``
# @param [String] name
# Required. ID of the resource file. Must match the regular expression: [a-zA-Z0-
# 9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_resourcefile(parent, type, name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/resourcefiles/{type}/{name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
command.params['parent'] = parent unless parent.nil?
command.params['type'] = type unless type.nil?
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all resource files, optionally filtering by type. For more information
# about resource files, see [Resource files](https://cloud.google.com/apigee/
# docs/api-platform/develop/resource-files).
# @param [String] parent
# Required. Name of the environment in which to list resource files in the
# following format: `organizations/`org`/environments/`env``.
# @param [String] type
# Optional. Type of resource files to list. `` resource_file_type ``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_environment_resourcefiles(parent, type: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/resourcefiles', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse
command.params['parent'] = parent unless parent.nil?
command.query['type'] = type unless type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all resource files, optionally filtering by type. For more information
# about resource files, see [Resource files](https://cloud.google.com/apigee/
# docs/api-platform/develop/resource-files).
# @param [String] parent
# Required. Name of the environment in which to list resource files in the
# following format: `organizations/`org`/environments/`env``.
# @param [String] type
# Optional. Type of resource files to list. `` resource_file_type ``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_environment_resourcefile_environment_resources(parent, type, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/resourcefiles/{type}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListEnvironmentResourcesResponse
command.params['parent'] = parent unless parent.nil?
command.params['type'] = type unless type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a resource file. Specify the `Content-Type` as `application/octet-
# stream` or `multipart/form-data`. For more information about resource files,
# see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/
# resource-files).
# @param [String] parent
# Required. Name of the environment in the following format: `organizations/`org`
# /environments/`env``.
# @param [String] type
# Required. Resource file type. `` resource_file_type ``
# @param [String] name
# Required. ID of the resource file to update. Must match the regular expression:
# [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255`
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_environment_resourcefile(parent, type, name, google_api_http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+parent}/resourcefiles/{type}/{name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.request_object = google_api_http_body_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFile
command.params['parent'] = parent unless parent.nil?
command.params['type'] = type unless type.nil?
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of a shared flow in an environment.
# @param [String] parent
# Required. Name representing a shared flow in an environment in the following
# format: `organizations/`org`/environments/`env`/sharedflows/`sharedflow``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_environment_sharedflow_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deploys a revision of a shared flow. If another revision of the same shared
# flow is currently deployed, set the `override` parameter to `true` to have
# this revision replace the currently deployed revision. You cannot use a shared
# flow until it has been deployed to an environment. For a request path `
# organizations/`org`/environments/`env`/sharedflows/`sf`/revisions/`rev`/
# deployments`, two permissions are required: * `apigee.deployments.create` on
# the resource `organizations/`org`/environments/`env`` * `apigee.
# sharedflowrevisions.deploy` on the resource `organizations/`org`/sharedflows/`
# sf`/revisions/`rev``
# @param [String] name
# Required. Name of the shared flow revision to deploy in the following format: `
# organizations/`org`/environments/`env`/sharedflows/`sharedflow`/revisions/`rev`
# `
# @param [Boolean] override
# Flag that specifies whether to force the deployment of the new revision over
# the currently deployed revision by overriding conflict checks. If an existing
# shared flow revision is deployed, to ensure seamless deployment with no
# downtime, set this parameter to `true`. In this case, hybrid deploys the new
# revision fully before undeploying the existing revision. If set to `false`,
# you must undeploy the existing revision before deploying the new revision.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def deploy_organization_environment_sharedflow_revision(name, override: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment
command.params['name'] = name unless name.nil?
command.query['override'] = override unless override.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the deployment of a shared flow revision and actual state reported by
# runtime pods.
# @param [String] name
# Required. Name representing a shared flow in an environment in the following
# format: `organizations/`org`/environments/`env`/sharedflows/`sharedflow`/
# revisions/`rev``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_sharedflow_revision_deployments(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Deployment
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Undeploys a shared flow revision from an environment. For a request path `
# organizations/`org`/environments/`env`/sharedflows/`sf`/revisions/`rev`/
# deployments`, two permissions are required: * `apigee.deployments.delete` on
# the resource `organizations/`org`/environments/`env`` * `apigee.
# sharedflowrevisions.undeploy` on the resource `organizations/`org`/sharedflows/
# `sf`/revisions/`rev``
# @param [String] name
# Required. Name of the shared flow revision to undeploy in the following format:
# `organizations/`org`/environments/`env`/sharedflows/`sharedflow`/revisions/`
# rev``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def undeploy_organization_environment_sharedflow_revision(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieve metrics grouped by dimensions. The types of metrics you can retrieve
# include traffic, message counts, API call latency, response size, and cache
# hits and counts. Dimensions let you view metrics in meaningful groups. The
# stats api does accept dimensions as path params. The dimensions are optional
# in which case the metrics are computed on the entire data for the given
# timerange.
# @param [String] name
# Required. The resource name for which the interactive query will be executed.
# Must be of the form `organizations/`organization_id`/environments/`
# environment_id/stats/`dimensions`` Dimensions let you view metrics in
# meaningful groupings. E.g. apiproxy, target_host. The value of dimensions
# should be comma separated list as shown below `organizations/`org`/
# environments/`env`/stats/apiproxy,request_verb`
# @param [String] accuracy
# Legacy field: not used anymore. This field is present to support UI calls
# which still use this parameter.
# @param [String] agg_table
# If customers want to query custom aggregate tables, then this parameter can be
# used to specify the table name. If this parameter is skipped, then Edge Query
# will try to retrieve the data from fact tables which will be expensive.
# @param [String] filter
# Enables drill-down on specific dimension values
# @param [String] limit
# This parameter is used to limit the number of result items. Default and the
# max value is 14400.
# @param [String] offset
# Use offset with limit to enable pagination of results. For example, to display
# results 11-20, set limit to '10' and offset to '10'.
# @param [Boolean] realtime
# Legacy field: not used anymore.
# @param [String] select
# The select parameter contains a comma separated list of metrics. E.g. sum(
# message_count),sum(error_count)
# @param [Boolean] sonar
# This parameter routes the query to api monitoring service for last hour.
# @param [String] sort
# This parameter specifies if the sort order should be ascending or descending
# Supported values are DESC and ASC.
# @param [String] sortby
# Comma separated list of columns to sort the final result.
# @param [String] time_range
# Time interval for the interactive query. Time range is specified as start~end
# E.g. 04/15/2017 00:00~05/15/2017 23:59
# @param [String] time_unit
# A value of second, minute, hour, day, week, month. Time Unit specifies the
# granularity of metrics returned.
# @param [String] topk
# Take 'top k' results from results, for example, to return the top 5 results '
# topk=5'.
# @param [Boolean] ts_ascending
# Lists timestamps in ascending order if set to true. Recommend setting this
# value to true if you are using sortby with sort=DESC.
# @param [String] tzo
# This parameters contains the timezone offset value.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_stat(name, accuracy: nil, agg_table: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sonar: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats
command.params['name'] = name unless name.nil?
command.query['accuracy'] = accuracy unless accuracy.nil?
command.query['aggTable'] = agg_table unless agg_table.nil?
command.query['filter'] = filter unless filter.nil?
command.query['limit'] = limit unless limit.nil?
command.query['offset'] = offset unless offset.nil?
command.query['realtime'] = realtime unless realtime.nil?
command.query['select'] = select unless select.nil?
command.query['sonar'] = sonar unless sonar.nil?
command.query['sort'] = sort unless sort.nil?
command.query['sortby'] = sortby unless sortby.nil?
command.query['timeRange'] = time_range unless time_range.nil?
command.query['timeUnit'] = time_unit unless time_unit.nil?
command.query['topk'] = topk unless topk.nil?
command.query['tsAscending'] = ts_ascending unless ts_ascending.nil?
command.query['tzo'] = tzo unless tzo.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a TargetServer in the specified environment.
# @param [String] parent
# Required. The parent environment name under which the TargetServer will be
# created. Must be of the form `organizations/`org`/environments/`env``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] google_cloud_apigee_v1_target_server_object
# @param [String] name
# Optional. The ID to give the TargetServer. This will overwrite the value in
# TargetServer.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_environment_targetserver(parent, google_cloud_apigee_v1_target_server_object = nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/targetservers', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
command.request_object = google_cloud_apigee_v1_target_server_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer
command.params['parent'] = parent unless parent.nil?
command.query['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a TargetServer from an environment. Returns the deleted TargetServer
# resource.
# @param [String] name
# Required. The name of the TargetServer to delete. Must be of the form `
# organizations/`org`/environments/`env`/targetservers/`target_server_id``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_environment_targetserver(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a TargetServer resource.
# @param [String] name
# Required. The name of the TargetServer to get. Must be of the form `
# organizations/`org`/environments/`env`/targetservers/`target_server_id``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_environment_targetserver(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an existing TargetServer. Note that this operation has PUT semantics;
# it will replace the entirety of the existing TargetServer with the resource in
# the request body.
# @param [String] name
# Required. The name of the TargetServer to replace. Must be of the form `
# organizations/`org`/environments/`env`/targetservers/`target_server_id``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] google_cloud_apigee_v1_target_server_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_environment_targetserver(name, google_cloud_apigee_v1_target_server_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
command.request_object = google_cloud_apigee_v1_target_server_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Submit a query at host level to be processed in the background. If the
# submission of the query succeeds, the API returns a 201 status and an ID that
# refer to the query. In addition to the HTTP status 201, the `state` of "
# enqueued" means that the request succeeded.
# @param [String] parent
# Required. The parent resource name. Must be of the form `organizations/`org``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query] google_cloud_apigee_v1_query_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_host_query(parent, google_cloud_apigee_v1_query_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/hostQueries', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query::Representation
command.request_object = google_cloud_apigee_v1_query_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get status of a query submitted at host level. If the query is still in
# progress, the `state` is set to "running" After the query has completed
# successfully, `state` is set to "completed"
# @param [String] name
# Required. Name of the asynchronous query to get. Must be of the form `
# organizations/`org`/queries/`queryId``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_host_query(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# After the query is completed, use this API to retrieve the results. If the
# request succeeds, and there is a non-zero result set, the result is downloaded
# to the client as a zipped JSON file. The name of the downloaded file will be:
# OfflineQueryResult-.zip Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-
# 318d0cb961bd.zip`
# @param [String] name
# Required. Name of the asynchronous query result to get. Must be of the form `
# organizations/`org`/queries/`queryId`/result`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_host_query_result(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
#
# @param [String] name
# Required. Name of the asynchronous query result view to get. Must be of the
# form `organizations/`org`/queries/`queryId`/resultView`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_host_query_result_view(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResultView
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Return a list of Asynchronous Queries at host level.
# @param [String] parent
# Required. The parent resource name. Must be of the form `organizations/`org``.
# @param [String] dataset
# Filter response list by dataset. Example: `api`, `mint`
# @param [String] envgroup_hostname
# Required. Filter response list by hostname.
# @param [String] from
# Filter response list by returning asynchronous queries that created after this
# date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.
# @param [String] incl_queries_without_report
# Flag to include asynchronous queries that don't have a report denifition.
# @param [String] status
# Filter response list by asynchronous query status.
# @param [String] submitted_by
# Filter response list by user who submitted queries.
# @param [String] to
# Filter response list by returning asynchronous queries that created before
# this date time. Time must be in ISO date-time format like '2011-12-03T10:16:
# 30Z'.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_host_queries(parent, dataset: nil, envgroup_hostname: nil, from: nil, incl_queries_without_report: nil, status: nil, submitted_by: nil, to: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/hostQueries', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAsyncQueriesResponse
command.params['parent'] = parent unless parent.nil?
command.query['dataset'] = dataset unless dataset.nil?
command.query['envgroupHostname'] = envgroup_hostname unless envgroup_hostname.nil?
command.query['from'] = from unless from.nil?
command.query['inclQueriesWithoutReport'] = incl_queries_without_report unless incl_queries_without_report.nil?
command.query['status'] = status unless status.nil?
command.query['submittedBy'] = submitted_by unless submitted_by.nil?
command.query['to'] = to unless to.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieve metrics grouped by dimensions in host level. The types of metrics you
# can retrieve include traffic, message counts, API call latency, response size,
# and cache hits and counts. Dimensions let you view metrics in meaningful
# groups. The stats api does accept dimensions as path params. The dimensions
# are optional in which case the metrics are computed on the entire data for the
# given timerange.
# @param [String] name
# Required. The resource name for which the interactive query will be executed.
# Must be of the form `organizations/`organization_id`/stats/`dimensions``.
# Dimensions let you view metrics in meaningful groupings. E.g. apiproxy,
# target_host. The value of dimensions should be comma separated list as shown
# below `organizations/`org`/stats/apiproxy,request_verb`
# @param [String] accuracy
# Legacy field: not used anymore.
# @param [String] envgroup_hostname
# Required. The hostname for which the interactive query will be executed.
# @param [String] filter
# Enables drill-down on specific dimension values.
# @param [String] limit
# This parameter is used to limit the number of result items. Default and the
# max value is 14400.
# @param [String] offset
# Use offset with limit to enable pagination of results. For example, to display
# results 11-20, set limit to '10' and offset to '10'.
# @param [Boolean] realtime
# Legacy field: not used anymore.
# @param [String] select
# The select parameter contains a comma separated list of metrics. E.g. sum(
# message_count),sum(error_count)
# @param [String] sort
# This parameter specifies if the sort order should be ascending or descending
# Supported values are DESC and ASC.
# @param [String] sortby
# Comma separated list of columns to sort the final result.
# @param [String] time_range
# Time interval for the interactive query. Time range is specified as start~end
# E.g. 04/15/2017 00:00~05/15/2017 23:59
# @param [String] time_unit
# A value of second, minute, hour, day, week, month. Time Unit specifies the
# granularity of metrics returned.
# @param [String] topk
# Take 'top k' results from results, for example, to return the top 5 results '
# topk=5'.
# @param [Boolean] ts_ascending
# Lists timestamps in ascending order if set to true. Recommend setting this
# value to true if you are using sortby with sort=DESC.
# @param [String] tzo
# This parameters contains the timezone offset value.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_host_stat(name, accuracy: nil, envgroup_hostname: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Stats
command.params['name'] = name unless name.nil?
command.query['accuracy'] = accuracy unless accuracy.nil?
command.query['envgroupHostname'] = envgroup_hostname unless envgroup_hostname.nil?
command.query['filter'] = filter unless filter.nil?
command.query['limit'] = limit unless limit.nil?
command.query['offset'] = offset unless offset.nil?
command.query['realtime'] = realtime unless realtime.nil?
command.query['select'] = select unless select.nil?
command.query['sort'] = sort unless sort.nil?
command.query['sortby'] = sortby unless sortby.nil?
command.query['timeRange'] = time_range unless time_range.nil?
command.query['timeUnit'] = time_unit unless time_unit.nil?
command.query['topk'] = topk unless topk.nil?
command.query['tsAscending'] = ts_ascending unless ts_ascending.nil?
command.query['tzo'] = tzo unless tzo.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates an Apigee runtime instance. The instance is accessible from the
# authorized network configured on the organization. **Note:** Not supported for
# Apigee hybrid.
# @param [String] parent
# Required. Name of the organization. Use the following structure in your
# request: `organizations/`org``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance] google_cloud_apigee_v1_instance_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_instance(parent, google_cloud_apigee_v1_instance_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/instances', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance::Representation
command.request_object = google_cloud_apigee_v1_instance_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an Apigee runtime instance. The instance stops serving requests and
# the runtime data is deleted. **Note:** Not supported for Apigee hybrid.
# @param [String] name
# Required. Name of the instance. Use the following structure in your request: `
# organizations/`org`/instances/`instance``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_instance(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the details for an Apigee runtime instance. **Note:** Not supported for
# Apigee hybrid.
# @param [String] name
# Required. Name of the instance. Use the following structure in your request: `
# organizations/`org`/instances/`instance``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_instance(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all Apigee runtime instances for the organization. **Note:** Not
# supported for Apigee hybrid.
# @param [String] parent
# Required. Name of the organization. Use the following structure in your
# request: `organizations/`org``.
# @param [Fixnum] page_size
# Maximum number of instances to return. Defaults to 25.
# @param [String] page_token
# Page token, returned from a previous ListInstances call, that you can use to
# retrieve the next page of content.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstancesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstancesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/instances', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstancesResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstancesResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Reports the latest status for a runtime instance.
# @param [String] instance
# The name of the instance reporting this status. For SaaS the request will be
# rejected if no instance exists under this name. Format is organizations/`org`/
# instances/`instance`
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusRequest] google_cloud_apigee_v1_report_instance_status_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def report_organization_instance_status(instance, google_cloud_apigee_v1_report_instance_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+instance}:reportStatus', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusRequest::Representation
command.request_object = google_cloud_apigee_v1_report_instance_status_request_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusResponse
command.params['instance'] = instance unless instance.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new attachment of an environment to an instance. **Note:** Not
# supported for Apigee hybrid.
# @param [String] parent
# Required. Name of the instance. Use the following structure in your request: `
# organizations/`org`/instances/`instance``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment] google_cloud_apigee_v1_instance_attachment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_instance_attachment(parent, google_cloud_apigee_v1_instance_attachment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/attachments', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment::Representation
command.request_object = google_cloud_apigee_v1_instance_attachment_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an attachment. **Note:** Not supported for Apigee hybrid.
# @param [String] name
# Required. Name of the attachment. Use the following structure in your request:
# `organizations/`org`/instances/`instance`/attachments/`attachment``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_instance_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets an attachment. **Note:** Not supported for Apigee hybrid.
# @param [String] name
# Required. Name of the attachment. Use the following structure in your request:
# `organizations/`org`/instances/`instance`/attachments/`attachment``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_instance_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all attachments to an instance. **Note:** Not supported for Apigee
# hybrid.
# @param [String] parent
# Required. Name of the organization. Use the following structure in your
# request: `organizations/`org`/instances/`instance``
# @param [Fixnum] page_size
# Maximum number of instance attachments to return. Defaults to 25.
# @param [String] page_token
# Page token, returned by a previous ListInstanceAttachments call, that you can
# use to retrieve the next page of content.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstanceAttachmentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstanceAttachmentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_instance_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/attachments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstanceAttachmentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListInstanceAttachmentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new canary evaluation for an organization.
# @param [String] parent
# Required. Name of the organization. Use the following structure in your
# request: `organizations/`org`/instances/`instance``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation] google_cloud_apigee_v1_canary_evaluation_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_instance_canaryevaluation(parent, google_cloud_apigee_v1_canary_evaluation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/canaryevaluations', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation::Representation
command.request_object = google_cloud_apigee_v1_canary_evaluation_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a CanaryEvaluation for an organization.
# @param [String] name
# Required. Name of the CanaryEvaluation. Use the following structure in your
# request: `organizations/`org`/instances/*/canaryevaluations/`evaluation``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_instance_canaryevaluation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CanaryEvaluation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Activates the NAT address. The Apigee instance can now use this for Internet
# egress traffic. **Note:** Not supported for Apigee hybrid.
# @param [String] name
# Required. Name of the nat address. Use the following structure in your request:
# `organizations/`org`/instances/`instances`/natAddresses/`nataddress```
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ActivateNatAddressRequest] google_cloud_apigee_v1_activate_nat_address_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def activate_organization_instance_nat_address(name, google_cloud_apigee_v1_activate_nat_address_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:activate', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ActivateNatAddressRequest::Representation
command.request_object = google_cloud_apigee_v1_activate_nat_address_request_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a NAT address. The address is created in the RESERVED state and a
# static external IP address will be provisioned. At this time, the instance
# will not use this IP address for Internet egress traffic. The address can be
# activated for use once any required firewall IP whitelisting has been
# completed. **Note:** Not supported for Apigee hybrid.
# @param [String] parent
# Required. Name of the instance. Use the following structure in your request: `
# organizations/`org`/instances/`instance``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress] google_cloud_apigee_v1_nat_address_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_instance_nat_address(parent, google_cloud_apigee_v1_nat_address_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/natAddresses', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress::Representation
command.request_object = google_cloud_apigee_v1_nat_address_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the NAT address. Connections that are actively using the address are
# drained before it is removed. **Note:** Not supported for Apigee hybrid.
# @param [String] name
# Required. Name of the nat address. Use the following structure in your request:
# `organizations/`org`/instances/`instances`/natAddresses/`nataddress```
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_instance_nat_address(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the details of a NAT address. **Note:** Not supported for Apigee hybrid.
# @param [String] name
# Required. Name of the nat address. Use the following structure in your request:
# `organizations/`org`/instances/`instances`/natAddresses/`nataddress``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_instance_nat_address(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1NatAddress
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the NAT addresses for an Apigee instance. **Note:** Not supported for
# Apigee hybrid.
# @param [String] parent
# Required. Name of the instance. Use the following structure in your request: `
# organizations/`org`/instances/`instance``
# @param [Fixnum] page_size
# Maximum number of natAddresses to return. Defaults to 25.
# @param [String] page_token
# Page token, returned from a previous ListNatAddresses call, that you can use
# to retrieve the next page of content.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListNatAddressesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListNatAddressesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_instance_nat_addresses(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/natAddresses', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListNatAddressesResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListNatAddressesResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a key value map in an organization.
# @param [String] parent
# Required. The name of the organization in which to create the key value map
# file. Must be of the form `organizations/`organization``.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_keyvaluemap(parent, google_cloud_apigee_v1_key_value_map_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/keyvaluemaps', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
command.request_object = google_cloud_apigee_v1_key_value_map_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Delete a key value map in an organization.
# @param [String] name
# Required. The name of the key value map. Must be of the form `organizations/`
# organization`/keyvaluemaps/`keyvaluemap``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_keyvaluemap(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the latest state of a long-running operation. Clients can use this method
# to poll the operation result at intervals as recommended by the API service.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists operations that match the specified filter in the request. If the server
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
# binding allows API services to override the binding to use different resource
# name schemes, such as `users/*/operations`. To override the binding, API
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
# service configuration. For backwards compatibility, the default name includes
# the operations collection id, however overriding users must ensure the name
# binding is the parent resource, without the operations collection id.
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
# The standard list filter.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] page_token
# The standard list page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/operations', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningListOperationsResponse
command.params['name'] = name unless name.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# This api is similar to GetHostStats except that the response is less verbose.
# @param [String] name
# Required. The resource name for which the interactive query will be executed.
# Must be of the form `organizations/`organization_id`/stats/`dimensions``.
# Dimensions let you view metrics in meaningful groupings. E.g. apiproxy,
# target_host. The value of dimensions should be comma separated list as shown
# below `organizations/`org`/stats/apiproxy,request_verb`
# @param [String] accuracy
# Legacy field: not used anymore.
# @param [String] envgroup_hostname
# Required. The hostname for which the interactive query will be executed.
# @param [String] filter
# Enables drill-down on specific dimension values.
# @param [String] limit
# This parameter is used to limit the number of result items. Default and the
# max value is 14400.
# @param [String] offset
# Use offset with limit to enable pagination of results. For example, to display
# results 11-20, set limit to '10' and offset to '10'.
# @param [Boolean] realtime
# Legacy field: not used anymore.
# @param [String] select
# Required. The select parameter contains a comma separated list of metrics. E.g.
# sum(message_count),sum(error_count)
# @param [String] sort
# This parameter specifies if the sort order should be ascending or descending
# Supported values are DESC and ASC.
# @param [String] sortby
# Comma separated list of columns to sort the final result.
# @param [String] time_range
# Required. Time interval for the interactive query. Time range is specified as
# start~end. E.g 04/15/2017 00:00~05/15/2017 23:59.
# @param [String] time_unit
# A value of second, minute, hour, day, week, month. Time Unit specifies the
# granularity of metrics returned.
# @param [String] topk
# Take 'top k' results from results, for example, to return the top 5 results '
# topk=5'.
# @param [Boolean] ts_ascending
# Lists timestamps in ascending order if set to true. Recommend setting this
# value to true if you are using sortby with sort=DESC.
# @param [String] tzo
# This parameters contains the timezone offset value.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_optimized_host_stat(name, accuracy: nil, envgroup_hostname: nil, filter: nil, limit: nil, offset: nil, realtime: nil, select: nil, sort: nil, sortby: nil, time_range: nil, time_unit: nil, topk: nil, ts_ascending: nil, tzo: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStats
command.params['name'] = name unless name.nil?
command.query['accuracy'] = accuracy unless accuracy.nil?
command.query['envgroupHostname'] = envgroup_hostname unless envgroup_hostname.nil?
command.query['filter'] = filter unless filter.nil?
command.query['limit'] = limit unless limit.nil?
command.query['offset'] = offset unless offset.nil?
command.query['realtime'] = realtime unless realtime.nil?
command.query['select'] = select unless select.nil?
command.query['sort'] = sort unless sort.nil?
command.query['sortby'] = sortby unless sortby.nil?
command.query['timeRange'] = time_range unless time_range.nil?
command.query['timeUnit'] = time_unit unless time_unit.nil?
command.query['topk'] = topk unless topk.nil?
command.query['tsAscending'] = ts_ascending unless ts_ascending.nil?
command.query['tzo'] = tzo unless tzo.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a Custom Report for an Organization. A Custom Report provides Apigee
# Customers to create custom dashboards in addition to the standard dashboards
# which are provided. The Custom Report in its simplest form contains
# specifications about metrics, dimensions and filters. It is important to note
# that the custom report by itself does not provide an executable entity. The
# Edge UI converts the custom report definition into an analytics query and
# displays the result in a chart.
# @param [String] parent
# Required. The parent organization name under which the Custom Report will be
# created. Must be of the form: `organizations/`organization_id`/reports`
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] google_cloud_apigee_v1_custom_report_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_report(parent, google_cloud_apigee_v1_custom_report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/reports', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
command.request_object = google_cloud_apigee_v1_custom_report_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an existing custom report definition
# @param [String] name
# Required. Custom Report name of the form: `organizations/`organization_id`/
# reports/`report_name``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_report(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeleteCustomReportResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieve a custom report definition.
# @param [String] name
# Required. Custom Report name of the form: `organizations/`organization_id`/
# reports/`report_name``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_report(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Return a list of Custom Reports
# @param [String] parent
# Required. The parent organization name under which the API product will be
# listed `organizations/`organization_id`/reports`
# @param [Boolean] expand
# Set to 'true' to get expanded details about each custom report.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_reports(parent, expand: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/reports', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListCustomReportsResponse
command.params['parent'] = parent unless parent.nil?
command.query['expand'] = expand unless expand.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update an existing custom report definition
# @param [String] name
# Required. Custom Report name of the form: `organizations/`organization_id`/
# reports/`report_name``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] google_cloud_apigee_v1_custom_report_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_report(name, google_cloud_apigee_v1_custom_report_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
command.request_object = google_cloud_apigee_v1_custom_report_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Uploads a ZIP-formatted shared flow configuration bundle to an organization.
# If the shared flow already exists, this creates a new revision of it. If the
# shared flow does not exist, this creates it. Once imported, the shared flow
# revision must be deployed before it can be accessed at runtime. The size limit
# of a shared flow bundle is 15 MB.
# @param [String] parent
# Required. The name of the parent organization under which to create the shared
# flow. Must be of the form: `organizations/`organization_id``
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [String] action
# Required. Must be set to either `import` or `validate`.
# @param [String] name
# Required. The name to give the shared flow
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_sharedflow(parent, google_api_http_body_object = nil, action: nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/sharedflows', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.request_object = google_api_http_body_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision
command.params['parent'] = parent unless parent.nil?
command.query['action'] = action unless action.nil?
command.query['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a shared flow and all it's revisions. The shared flow must be
# undeployed before you can delete it.
# @param [String] name
# Required. shared flow name of the form: `organizations/`organization_id`/
# sharedflows/`shared_flow_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_sharedflow(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a shared flow by name, including a list of its revisions.
# @param [String] name
# Required. The name of the shared flow to get. Must be of the form: `
# organizations/`organization_id`/sharedflows/`shared_flow_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_sharedflow(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlow
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all shared flows in the organization.
# @param [String] parent
# Required. The name of the parent organization under which to get shared flows.
# Must be of the form: `organizations/`organization_id``
# @param [Boolean] include_meta_data
# Indicates whether to include shared flow metadata in the response.
# @param [Boolean] include_revisions
# Indicates whether to include a list of revisions in the response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_sharedflows(parent, include_meta_data: nil, include_revisions: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/sharedflows', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListSharedFlowsResponse
command.params['parent'] = parent unless parent.nil?
command.query['includeMetaData'] = include_meta_data unless include_meta_data.nil?
command.query['includeRevisions'] = include_revisions unless include_revisions.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of a shared flow.
# @param [String] parent
# Required. Name of the shared flow for which to return deployment information
# in the following format: `organizations/`org`/sharedflows/`sharedflow``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_sharedflow_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a shared flow and all associated policies, resources, and revisions.
# You must undeploy the shared flow before deleting it.
# @param [String] name
# Required. The name of the shared flow revision to delete. Must be of the form:
# `organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/`
# revision_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_sharedflow_revision(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a revision of a shared flow. If `format=bundle` is passed, it instead
# outputs a shared flow revision as a ZIP-formatted bundle of code and config
# files.
# @param [String] name
# Required. The name of the shared flow revision to get. Must be of the form: `
# organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/`
# revision_id``
# @param [String] format
# Specify `bundle` to export the contents of the shared flow bundle. Otherwise,
# the bundle metadata is returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleApiHttpBody] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleApiHttpBody]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_sharedflow_revision(name, format: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleApiHttpBody
command.params['name'] = name unless name.nil?
command.query['format'] = format unless format.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a shared flow revision. This operation is only allowed on revisions
# which have never been deployed. After deployment a revision becomes immutable,
# even if it becomes undeployed. The payload is a ZIP-formatted shared flow.
# Content type must be either multipart/form-data or application/octet-stream.
# @param [String] name
# Required. The name of the shared flow revision to update. Must be of the form:
# `organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/`
# revision_id``
# @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object
# @param [Boolean] validate
# Ignored. All uploads are validated regardless of the value of this field. It
# is kept for compatibility with existing APIs. Must be `true` or `false` if
# provided.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_sharedflow_revision_shared_flow_revision(name, google_api_http_body_object = nil, validate: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleApiHttpBody::Representation
command.request_object = google_api_http_body_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1SharedFlowRevision
command.params['name'] = name unless name.nil?
command.query['validate'] = validate unless validate.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all deployments of a shared flow revision.
# @param [String] parent
# Required. Name of the API proxy revision for which to return deployment
# information in the following format: `organizations/`org`/sharedflows/`
# sharedflow`/revisions/`rev``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_sharedflow_revision_deployments(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/deployments', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListDeploymentsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new category on the portal.
# @param [String] parent
# Required. Name of the portal. Use the following structure in your request: `
# organizations/`org`/sites/`site``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryData] google_cloud_apigee_v1_api_category_data_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_organization_site_apicategory(parent, google_cloud_apigee_v1_api_category_data_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/apicategories', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryData::Representation
command.request_object = google_cloud_apigee_v1_api_category_data_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a category from the portal.
# @param [String] name
# Required. Name of the category. Use the following structure in your request: `
# organizations/`org`/sites/`site`/apicategories/`apicategory``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiResponseWrapper] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiResponseWrapper]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_site_apicategory(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiResponseWrapper::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiResponseWrapper
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a category on the portal.
# @param [String] name
# Required. Name of the category. Use the following structure in your request: `
# organizations/`org`/sites/`site`/apicategories/`apicategory``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_site_apicategory(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists the categories on the portal.
# @param [String] parent
# Required. Name of the portal. Use the following structure in your request: `
# organizations/`org`/sites/`site``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiCategoriesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiCategoriesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_site_apicategories(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/apicategories', options)
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiCategoriesResponse::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListApiCategoriesResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a category on the portal.
# @param [String] name
# Required. Name of the category. Use the following structure in your request: `
# organizations/`org`/sites/`site`/apicategories/`apicategory``
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryData] google_cloud_apigee_v1_api_category_data_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_organization_site_apicategory(name, google_cloud_apigee_v1_api_category_data_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategoryData::Representation
command.request_object = google_cloud_apigee_v1_api_category_data_object
command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiCategory
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Provisions a new Apigee organization with a functioning runtime. This is the
# standard way to create trial organizations for a free Apigee trial.
# @param [String] project
# Required. Name of the GCP project with which to associate the Apigee
# organization.
# @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ProvisionOrganizationRequest] google_cloud_apigee_v1_provision_organization_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ApigeeV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ApigeeV1::GoogleLongrunningOperation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def provision_project_organization(project, google_cloud_apigee_v1_provision_organization_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+project}:provisionOrganization', options)
command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ProvisionOrganizationRequest::Representation
command.request_object = google_cloud_apigee_v1_provision_organization_request_object
command.response_representation = Google::Apis::ApigeeV1::GoogleLongrunningOperation::Representation
command.response_class = Google::Apis::ApigeeV1::GoogleLongrunningOperation
command.params['project'] = project unless project.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|