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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="apihub_v1.html">API hub API</a> . <a href="apihub_v1.projects.html">projects</a> . <a href="apihub_v1.projects.locations.html">locations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.apiHubInstances.html">apiHubInstances()</a></code>
</p>
<p class="firstline">Returns the apiHubInstances Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.apis.html">apis()</a></code>
</p>
<p class="firstline">Returns the apis Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.attributes.html">attributes()</a></code>
</p>
<p class="firstline">Returns the attributes Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.curations.html">curations()</a></code>
</p>
<p class="firstline">Returns the curations Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.dependencies.html">dependencies()</a></code>
</p>
<p class="firstline">Returns the dependencies Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.deployments.html">deployments()</a></code>
</p>
<p class="firstline">Returns the deployments Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.discoveredApiObservations.html">discoveredApiObservations()</a></code>
</p>
<p class="firstline">Returns the discoveredApiObservations Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.externalApis.html">externalApis()</a></code>
</p>
<p class="firstline">Returns the externalApis Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.hostProjectRegistrations.html">hostProjectRegistrations()</a></code>
</p>
<p class="firstline">Returns the hostProjectRegistrations Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.plugins.html">plugins()</a></code>
</p>
<p class="firstline">Returns the plugins Resource.</p>
<p class="toc_element">
<code><a href="apihub_v1.projects.locations.runtimeProjectAttachments.html">runtimeProjectAttachments()</a></code>
</p>
<p class="firstline">Returns the runtimeProjectAttachments Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#collectApiData">collectApiData(location, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Collect API data from a source and push it to Hub's collect layer.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists information about the supported locations for this service.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#lookupRuntimeProjectAttachment">lookupRuntimeProjectAttachment(name, x__xgafv=None)</a></code></p>
<p class="firstline">Look up a runtime project attachment. This API can be called in the context of any project.</p>
<p class="toc_element">
<code><a href="#searchResources">searchResources(location, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Search across API-Hub resources.</p>
<p class="toc_element">
<code><a href="#searchResources_next">searchResources_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="collectApiData">collectApiData(location, body=None, x__xgafv=None)</code>
<pre>Collect API data from a source and push it to Hub's collect layer.
Args:
location: string, Required. The regional location of the API hub instance and its resources. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # The CollectApiData method's request.
"actionId": "A String", # Required. The action ID to be used for collecting the API data. This should map to one of the action IDs specified in action configs in the plugin.
"apiData": { # The API data to be collected. # Required. The API data to be collected.
"apiMetadataList": { # The message to hold repeated API metadata. # Optional. The list of API metadata.
"apiMetadata": [ # Required. The list of API metadata.
{ # The API metadata.
"api": { # An API resource in the API Hub. # Required. The API resource to be pushed to Hub's collect layer. The ID of the API resource will be generated by Hub to ensure uniqueness across all APIs across systems.
"apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"createTime": "A String", # Output only. The time at which the API resource was created.
"description": "A String", # Optional. The description of the API resource.
"displayName": "A String", # Required. The display name of the API resource.
"documentation": { # Documentation details. # Optional. The documentation for the API resource.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"fingerprint": "A String", # Optional. Fingerprint of the API resource.
"maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
"owner": { # Owner details. # Optional. Owner details for the API resource.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the API resource was last updated.
"versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
"A String",
],
},
"originalCreateTime": "A String", # Optional. Timestamp indicating when the API was created at the source.
"originalId": "A String", # Optional. The unique identifier of the API in the system where it was originally created.
"originalUpdateTime": "A String", # Required. Timestamp indicating when the API was last updated at the source.
"versions": [ # Optional. The list of versions present in an API resource.
{ # The metadata associated with a version of the API resource.
"deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc.)
{ # The metadata associated with a deployment.
"deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # Required. The deployment resource to be pushed to Hub's collect layer. The ID of the deployment will be generated by Hub.
"apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
"A String",
],
"attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"createTime": "A String", # Output only. The time at which the deployment was created.
"deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"description": "A String", # Optional. The description of the deployment.
"displayName": "A String", # Required. The display name of the deployment.
"documentation": { # Documentation details. # Optional. The documentation of the deployment.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
"A String",
],
"environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"managementUrl": { # The attribute values associated with resource. # Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
"resourceUri": "A String", # Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders`.
"slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"sourceEnvironment": "A String", # Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceProject": "A String", # Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.
"sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the deployment was last updated.
},
"originalCreateTime": "A String", # Optional. Timestamp indicating when the deployment was created at the source.
"originalId": "A String", # Optional. The unique identifier of the deployment in the system where it was originally created.
"originalUpdateTime": "A String", # Required. Timestamp indicating when the deployment was last updated at the source.
},
],
"originalCreateTime": "A String", # Optional. Timestamp indicating when the version was created at the source.
"originalId": "A String", # Optional. The unique identifier of the version in the system where it was originally created.
"originalUpdateTime": "A String", # Required. Timestamp indicating when the version was last updated at the source.
"specs": [ # Optional. The specs associated with this version. Note that an API version can be associated with multiple specs.
{ # The metadata associated with a spec of the API version.
"originalCreateTime": "A String", # Optional. Timestamp indicating when the spec was created at the source.
"originalId": "A String", # Optional. The unique identifier of the spec in the system where it was originally created.
"originalUpdateTime": "A String", # Required. Timestamp indicating when the spec was last updated at the source.
"spec": { # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. # Required. The spec resource to be pushed to Hub's collect layer. The ID of the spec will be generated by Hub.
"attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
"contents": "A String", # Required. The contents of the spec.
"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
},
"createTime": "A String", # Output only. The time at which the spec was created.
"details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
"description": "A String", # Output only. The description of the spec.
"openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
"format": "A String", # Output only. The format of the spec.
"owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
},
},
"displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
"documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
"createTime": "A String", # Required. Timestamp when the linting response was generated.
"issues": [ # Optional. Array of issues found in the analyzed document.
{ # Issue contains the details of a single issue found by the linter.
"code": "A String", # Required. Rule code unique to each rule defined in linter.
"message": "A String", # Required. Human-readable message describing the issue found by the linter.
"path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
"A String",
],
"range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
"end": { # Point within the file (line and character). # Required. End of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
"start": { # Point within the file (line and character). # Required. Start of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
},
"severity": "A String", # Required. Severity level of the rule violation.
},
],
"linter": "A String", # Required. Name of the linter used.
"source": "A String", # Required. Name of the linting application.
"state": "A String", # Required. Lint state represents success or failure for linting.
"summary": [ # Optional. Summary of all issue types and counts for each severity level.
{ # Count of issues with a given severity.
"count": 42, # Required. Count of issues with the given severity.
"severity": "A String", # Required. Severity of the issue.
},
],
},
"name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
"specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the spec was last updated.
},
},
],
"version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # Required. Represents a version of the API resource in API hub. The ID of the version will be generated by Hub.
"accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
"A String",
],
"attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"createTime": "A String", # Output only. The time at which the version was created.
"definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
"A String",
],
"deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
"A String",
],
"description": "A String", # Optional. The description of the version.
"displayName": "A String", # Required. The display name of the version.
"documentation": { # Documentation details. # Optional. The documentation of the version.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
"selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"A String",
],
"updateTime": "A String", # Output only. The time at which the version was last updated.
},
},
],
},
],
},
},
"collectionType": "A String", # Required. The type of collection. Applies to all entries in api_data.
"pluginInstance": "A String", # Required. The plugin instance collecting the API data. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets information about a location.
Args:
name: string, Resource name for the location. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource that represents a Google Cloud location.
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
"metadata": { # Service-specific metadata. For example the available capacity at the given location.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists information about the supported locations for this service.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated)
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Locations.ListLocations.
"locations": [ # A list of locations that matches the specified filter in the request.
{ # A resource that represents a Google Cloud location.
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
"metadata": { # Service-specific metadata. For example the available capacity at the given location.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
},
],
"nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="lookupRuntimeProjectAttachment">lookupRuntimeProjectAttachment(name, x__xgafv=None)</code>
<pre>Look up a runtime project attachment. This API can be called in the context of any project.
Args:
name: string, Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: `projects/{project}/locations/{location}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The ListRuntimeProjectAttachments method's response.
"runtimeProjectAttachment": { # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments. # Runtime project attachment for a project if exists, empty otherwise.
"createTime": "A String", # Output only. Create time.
"name": "A String", # Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}".
"runtimeProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
},
}</pre>
</div>
<div class="method">
<code class="details" id="searchResources">searchResources(location, body=None, x__xgafv=None)</code>
<pre>Search across API-Hub resources.
Args:
location: string, Required. The resource name of the location which will be of the type `projects/{project_id}/locations/{location_id}`. This field is used to identify the instance of API-Hub in which resources should be searched. (required)
body: object, The request body.
The object takes the form of:
{ # The SearchResources method's request.
"filter": "A String", # Optional. An expression that filters the list of search results. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`. Filters are not case sensitive. The following field names are eligible for filtering: * `resource_type` - The type of resource in the search results. Must be one of the following: `Api`, `ApiOperation`, `Deployment`, `Definition`, `Spec` or `Version`. This field can only be specified once in the filter. Here are is an example: * `resource_type = Api` - The resource_type is _Api_.
"pageSize": 42, # Optional. The maximum number of search results to return. The service may return fewer than this value. If unspecified at most 10 search results will be returned. If value is negative then `INVALID_ARGUMENT` error is returned. The maximum value is 25; values above 25 will be coerced to 25. While paginating, you can specify a new page size parameter for each page of search results to be listed.
"pageToken": "A String", # Optional. A page token, received from a previous SearchResources call. Specify this parameter to retrieve the next page of transactions. When paginating, you must specify the `page_token` parameter and all the other parameters except page_size should be specified with the same value which was used in the previous call. If the other fields are set with a different value than the previous call then `INVALID_ARGUMENT` error is returned.
"query": "A String", # Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the SearchResources method.
"nextPageToken": "A String", # Pass this token in the SearchResourcesRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response.
"searchResults": [ # List of search results according to the filter and search query specified. The order of search results represents the ranking.
{ # Represents the search results.
"resource": { # ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub. # This represents the ApiHubResource. Note: Only selected fields of the resources are populated in response.
"api": { # An API resource in the API Hub. # This represents Api resource in search results. Only name, display_name, description and owner fields are populated in search results.
"apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"createTime": "A String", # Output only. The time at which the API resource was created.
"description": "A String", # Optional. The description of the API resource.
"displayName": "A String", # Required. The display name of the API resource.
"documentation": { # Documentation details. # Optional. The documentation for the API resource.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"fingerprint": "A String", # Optional. Fingerprint of the API resource.
"maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
"owner": { # Owner details. # Optional. Owner details for the API resource.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the API resource was last updated.
"versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
"A String",
],
},
"definition": { # Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only `schema` object is supported. # This represents Definition resource in search results. Only name field is populated in search results.
"attributes": { # Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"createTime": "A String", # Output only. The time at which the definition was created.
"name": "A String", # Identifier. The name of the definition. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
"schema": { # The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the `definitions` section for OpenAPI 2.0 version and in `components.schemas` section for OpenAPI 3.0 and 3.1 version. # Output only. The value of a schema definition.
"displayName": "A String", # Output only. The display name of the schema. This will map to the name of the schema in the spec.
"rawValue": "A String", # Output only. The raw value of the schema definition corresponding to the schema name in the spec.
},
"spec": "A String", # Output only. The name of the spec from where the definition was parsed. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"type": "A String", # Output only. The type of the definition.
"updateTime": "A String", # Output only. The time at which the definition was last updated.
},
"deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # This represents Deployment resource in search results. Only name, display_name, description, deployment_type and api_versions fields are populated in search results.
"apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
"A String",
],
"attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"createTime": "A String", # Output only. The time at which the deployment was created.
"deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"description": "A String", # Optional. The description of the deployment.
"displayName": "A String", # Required. The display name of the deployment.
"documentation": { # Documentation details. # Optional. The documentation of the deployment.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
"A String",
],
"environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"managementUrl": { # The attribute values associated with resource. # Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
"resourceUri": "A String", # Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders`.
"slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"sourceEnvironment": "A String", # Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceProject": "A String", # Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.
"sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the deployment was last updated.
},
"operation": { # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API. # This represents ApiOperation resource in search results. Only name, description, spec and details fields are populated in search results.
"attributes": { # Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"createTime": "A String", # Output only. The time at which the operation was created.
"details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.
"description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used.
"documentation": { # Documentation details. # Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"httpOperation": { # The HTTP Operation. # The HTTP Operation.
"method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
"description": "A String", # Optional. A short description for the path applicable to all operations.
"path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
},
},
},
"name": "A String", # Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API operation.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"spec": "A String", # Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
"updateTime": "A String", # Output only. The time at which the operation was last updated.
},
"spec": { # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. # This represents Spec resource in search results. Only name, display_name, description, spec_type and documentation fields are populated in search results.
"attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
"contents": "A String", # Required. The contents of the spec.
"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
},
"createTime": "A String", # Output only. The time at which the spec was created.
"details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
"description": "A String", # Output only. The description of the spec.
"openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
"format": "A String", # Output only. The format of the spec.
"owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
},
},
"displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
"documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
"createTime": "A String", # Required. Timestamp when the linting response was generated.
"issues": [ # Optional. Array of issues found in the analyzed document.
{ # Issue contains the details of a single issue found by the linter.
"code": "A String", # Required. Rule code unique to each rule defined in linter.
"message": "A String", # Required. Human-readable message describing the issue found by the linter.
"path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
"A String",
],
"range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
"end": { # Point within the file (line and character). # Required. End of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
"start": { # Point within the file (line and character). # Required. Start of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
},
"severity": "A String", # Required. Severity level of the rule violation.
},
],
"linter": "A String", # Required. Name of the linter used.
"source": "A String", # Required. Name of the linting application.
"state": "A String", # Required. Lint state represents success or failure for linting.
"summary": [ # Optional. Summary of all issue types and counts for each severity level.
{ # Count of issues with a given severity.
"count": 42, # Required. Count of issues with the given severity.
"severity": "A String", # Required. Severity of the issue.
},
],
},
"name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
"specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the spec was last updated.
},
"version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # This represents Version resource in search results. Only name, display_name, description, lifecycle, compliance and accreditation fields are populated in search results.
"accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
"A String",
],
"attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"createTime": "A String", # Output only. The time at which the version was created.
"definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
"A String",
],
"deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
"A String",
],
"description": "A String", # Optional. The description of the version.
"displayName": "A String", # Required. The display name of the version.
"documentation": { # Documentation details. # Optional. The documentation of the version.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
"selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"A String",
],
"updateTime": "A String", # Output only. The time at which the version was last updated.
},
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="searchResources_next">searchResources_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|