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
|
<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="cloudbuild_v1.html">Cloud Build API</a> . <a href="cloudbuild_v1.projects.html">projects</a> . <a href="cloudbuild_v1.projects.builds.html">builds</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done.</p>
<p class="toc_element">
<code><a href="#cancel">cancel(projectId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels a build in progress.</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="#create">create(projectId, body=None, parent=None, x__xgafv=None)</a></code></p>
<p class="firstline">Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).</p>
<p class="toc_element">
<code><a href="#get">get(projectId, id, name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, filter=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.</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="#retry">retry(projectId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code>
<pre>Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done.
Args:
name: string, Required. Name of the target build. For example: "projects/{$project_id}/builds/{$build_id}" (required)
body: object, The request body.
The object takes the form of:
{ # Request to approve or reject a pending build.
"approvalResult": { # ApprovalResult describes the decision and associated metadata of a manual approval of a build. # Approval decision and metadata.
"approvalTime": "A String", # Output only. The time when the approval decision was made.
"approverAccount": "A String", # Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.
"comment": "A String", # Optional. An optional comment for this manual approval result.
"decision": "A String", # Required. The decision of this manual approval.
"url": "A String", # Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.
},
}
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="cancel">cancel(projectId, id, body=None, x__xgafv=None)</code>
<pre>Cancels a build in progress.
Args:
projectId: string, Required. ID of the project. (required)
id: string, Required. ID of the build. (required)
body: object, The request body.
The object takes the form of:
{ # Request to cancel an ongoing build.
"id": "A String", # Required. ID of the build.
"name": "A String", # The name of the `Build` to cancel. Format: `projects/{project}/locations/{location}/builds/{build}`
"projectId": "A String", # Required. ID of the project.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
"approval": { # BuildApproval describes a build's approval configuration, state, and result. # Output only. Describes this build's approval configuration, status, and result.
"config": { # ApprovalConfig describes configuration for manual approval of a build. # Output only. Configuration for manual approval of this build.
"approvalRequired": True or False, # Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.
},
"result": { # ApprovalResult describes the decision and associated metadata of a manual approval of a build. # Output only. Result of manual approval for this Build.
"approvalTime": "A String", # Output only. The time when the approval decision was made.
"approverAccount": "A String", # Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.
"comment": "A String", # Optional. An optional comment for this manual approval result.
"decision": "A String", # Required. The decision of this manual approval.
"url": "A String", # Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.
},
"state": "A String", # Output only. The state of this build's approval.
},
"artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
"goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.
{ # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.
"modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2
"moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5
"repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location.
"repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo
"repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project.
"sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage
},
],
"images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"mavenArtifacts": [ # A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.
{ # A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.
"artifactId": "A String", # Maven `artifactId` value used when uploading the artifact to Artifact Registry.
"groupId": "A String", # Maven `groupId` value used when uploading the artifact to Artifact Registry.
"path": "A String", # Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix.
"version": "A String", # Maven `version` value used when uploading the artifact to Artifact Registry.
},
],
"npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE.
{ # Npm package to upload to Artifact Registry upon successful completion of all build steps.
"packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix.
},
],
"objects": { # Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. # A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.
"location": "A String", # Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.
"paths": [ # Path globs used to match files in the build's workspace.
"A String",
],
"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
"pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.
{ # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.
"paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file.
"A String",
],
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix.
},
],
},
"availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables.
"inline": [ # Secrets encrypted with KMS key and the associated secret environment variable.
{ # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
"envMap": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
"a_key": "A String",
},
"kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*
},
],
"secretManager": [ # Secrets in Secret Manager and associated secret environment variable.
{ # Pairs a secret environment variable with a SecretVersion in Secret Manager.
"env": "A String", # Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.
"versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*
},
],
},
"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.
"createTime": "A String", # Output only. Time at which the request to create the build was received.
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.
{ # A dependency that the Cloud Build worker will fetch before executing user steps.
"empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well).
"gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency.
"depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history).
"destPath": "A String", # Required. Where should the files be placed on the worker.
"recurseSubmodules": True or False, # Optional. True if submodules should be fetched too (default false).
"repository": { # A repository for a git source. # Required. The kind of repo (url or dev connect).
"developerConnect": "A String", # The Developer Connect Git repository link formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`
"url": "A String", # Location of the Git repository.
},
"revision": "A String", # Required. The revision that we will fetch the repo at.
},
},
],
"failureInfo": { # A fatal problem encountered during the execution of the build. # Output only. Contains information about the build when status=FAILURE.
"detail": "A String", # Explains the failure issue in more detail using hard-coded text.
"type": "A String", # The name of the failure.
},
"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.
"gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations.
"http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations.
"proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.
},
},
"id": "A String", # Output only. Unique identifier of the build.
"images": [ # A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.
"A String",
],
"logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.
"logsBucket": "A String", # Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
"name": "A String", # Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service.
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
"automapSubstitutions": True or False, # Option to include built-in and custom substitutions as env variables for all build steps.
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup.
"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error.
"dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.
"enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.
"env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
"A String",
],
"logStreamingOption": "A String", # Option to define build log streaming behavior to Cloud Storage.
"logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored.
"machineType": "A String", # Compute Engine machine type on which to run the build.
"pool": { # Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. # Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.
"name": "A String", # The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}
},
"pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates.
"requestedVerifyOption": "A String", # Requested verifiability options.
"secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.
"A String",
],
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.
"volumes": [ # Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.
{ # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
"name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
"path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
},
],
"workerPool": "A String", # This field deprecated; please use `pool.name` instead.
},
"projectId": "A String", # Output only. ID of the project.
"queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.
"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
"artifactManifest": "A String", # Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
"artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts to Cloud Storage.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"buildStepImages": [ # List of build step digests, in the order corresponding to build step indices.
"A String",
],
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted.
"A String",
],
"goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.
{ # A Go module artifact uploaded to Artifact Registry using the GoModule directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
"images": [ # Container images that were built as a part of the build.
{ # An image built by the pipeline.
"digest": "A String", # Docker Registry 2.0 digest.
"name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`.
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
],
"mavenArtifacts": [ # Maven artifacts uploaded to Artifact Registry at the end of the build.
{ # A Maven artifact uploaded using the MavenArtifact directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Maven Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
"npmPackages": [ # Npm packages uploaded to Artifact Registry at the end of the build.
{ # An npm package uploaded to Artifact Registry using the NpmPackage directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the npm package.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded npm package.
},
],
"numArtifacts": "A String", # Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
"pythonPackages": [ # Python artifacts uploaded to Artifact Registry at the end of the build.
{ # Artifact uploaded using the PythonPackage directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Python Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
},
"secrets": [ # Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets
{ # Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.
"kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
"secretEnv": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
"a_key": "A String",
},
},
],
"serviceAccount": "A String", # IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account.
"source": { # Location of the source in a supported storage service. # Optional. The location of the source files to build.
"connectedRepository": { # Location of the source in a 2nd-gen Google Cloud Build repository resource. # Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build.
"repository": "A String", # Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"developerConnectConfig": { # This config defines the location of a source through Developer Connect. # If provided, get the source from this Developer Connect config.
"dir": "A String", # Required. Directory, relative to the source root, in which to run the build.
"gitRepositoryLink": "A String", # Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"gitSource": { # Location of the source in any accessible Git repository. # If provided, get the source from this Git repository.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"revision": "A String", # Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.
"url": "A String", # Required. Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.
},
"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository.
"branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
"commitSha": "A String", # Explicit commit SHA to build.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"invertRegex": True or False, # Optional. Only trigger a build if the revision regex does NOT match the revision regex.
"projectId": "A String", # Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
"substitutions": { # Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
"a_key": "A String",
},
"tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
},
"storageSource": { # Location of the source in an archive file in Cloud Storage. # If provided, get the source from this location in Cloud Storage.
"bucket": "A String", # Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.
"sourceFetcher": "A String", # Optional. Option to specify the tool to fetch the source file for the build.
},
"storageSourceManifest": { # Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). # If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).
"bucket": "A String", # Required. Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source manifest. This object must be a JSON file.
},
},
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source.
"fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.
"a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
},
"resolvedConnectedRepository": { # Location of the source in a 2nd-gen Google Cloud Build repository resource. # Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build.
"repository": "A String", # Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"resolvedGitSource": { # Location of the source in any accessible Git repository. # Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"revision": "A String", # Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.
"url": "A String", # Required. Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.
},
"resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
"branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
"commitSha": "A String", # Explicit commit SHA to build.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"invertRegex": True or False, # Optional. Only trigger a build if the revision regex does NOT match the revision regex.
"projectId": "A String", # Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
"substitutions": { # Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
"a_key": "A String",
},
"tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
},
"resolvedStorageSource": { # Location of the source in an archive file in Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved.
"bucket": "A String", # Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.
"sourceFetcher": "A String", # Optional. Option to specify the tool to fetch the source file for the build.
},
"resolvedStorageSourceManifest": { # Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). # A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview.
"bucket": "A String", # Required. Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source manifest. This object must be a JSON file.
},
},
"startTime": "A String", # Output only. Time at which execution of the build was started.
"status": "A String", # Output only. Status of the build.
"statusDetail": "A String", # Output only. Customer-readable message about the current status.
"steps": [ # Required. The operations to be performed on the workspace.
{ # A step in the build pipeline.
"allowExitCodes": [ # Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.
42,
],
"allowFailure": True or False, # Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.
"args": [ # A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
"A String",
],
"automapSubstitutions": True or False, # Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.
"dir": "A String", # Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
"entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.
"env": [ # A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
"A String",
],
"exitCode": 42, # Output only. Return code from running the step.
"id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
"name": "A String", # Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
"pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.
"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.
"A String",
],
"status": "A String", # Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.
"timeout": "A String", # Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"volumes": [ # List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.
{ # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
"name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
"path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
},
],
"waitFor": [ # The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.
"A String",
],
},
],
"substitutions": { # Substitutions data for `Build` resource.
"a_key": "A String",
},
"tags": [ # Tags for annotation of a `Build`. These are not docker tags.
"A String",
],
"timeout": "A String", # Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes.
"timing": { # Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.
"a_key": { # Start and end times for a build execution phase.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
"warnings": [ # Output only. Non-fatal problems encountered during the execution of the build.
{ # A non-fatal problem encountered during the execution of the build.
"priority": "A String", # The priority for this warning.
"text": "A String", # Explanation of the warning generated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(projectId, body=None, parent=None, x__xgafv=None)</code>
<pre>Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).
Args:
projectId: string, Required. ID of the project. (required)
body: object, The request body.
The object takes the form of:
{ # A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
"approval": { # BuildApproval describes a build's approval configuration, state, and result. # Output only. Describes this build's approval configuration, status, and result.
"config": { # ApprovalConfig describes configuration for manual approval of a build. # Output only. Configuration for manual approval of this build.
"approvalRequired": True or False, # Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.
},
"result": { # ApprovalResult describes the decision and associated metadata of a manual approval of a build. # Output only. Result of manual approval for this Build.
"approvalTime": "A String", # Output only. The time when the approval decision was made.
"approverAccount": "A String", # Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.
"comment": "A String", # Optional. An optional comment for this manual approval result.
"decision": "A String", # Required. The decision of this manual approval.
"url": "A String", # Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.
},
"state": "A String", # Output only. The state of this build's approval.
},
"artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
"goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.
{ # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.
"modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2
"moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5
"repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location.
"repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo
"repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project.
"sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage
},
],
"images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"mavenArtifacts": [ # A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.
{ # A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.
"artifactId": "A String", # Maven `artifactId` value used when uploading the artifact to Artifact Registry.
"groupId": "A String", # Maven `groupId` value used when uploading the artifact to Artifact Registry.
"path": "A String", # Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix.
"version": "A String", # Maven `version` value used when uploading the artifact to Artifact Registry.
},
],
"npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE.
{ # Npm package to upload to Artifact Registry upon successful completion of all build steps.
"packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix.
},
],
"objects": { # Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. # A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.
"location": "A String", # Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.
"paths": [ # Path globs used to match files in the build's workspace.
"A String",
],
"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
"pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.
{ # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.
"paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file.
"A String",
],
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix.
},
],
},
"availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables.
"inline": [ # Secrets encrypted with KMS key and the associated secret environment variable.
{ # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
"envMap": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
"a_key": "A String",
},
"kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*
},
],
"secretManager": [ # Secrets in Secret Manager and associated secret environment variable.
{ # Pairs a secret environment variable with a SecretVersion in Secret Manager.
"env": "A String", # Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.
"versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*
},
],
},
"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.
"createTime": "A String", # Output only. Time at which the request to create the build was received.
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.
{ # A dependency that the Cloud Build worker will fetch before executing user steps.
"empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well).
"gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency.
"depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history).
"destPath": "A String", # Required. Where should the files be placed on the worker.
"recurseSubmodules": True or False, # Optional. True if submodules should be fetched too (default false).
"repository": { # A repository for a git source. # Required. The kind of repo (url or dev connect).
"developerConnect": "A String", # The Developer Connect Git repository link formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`
"url": "A String", # Location of the Git repository.
},
"revision": "A String", # Required. The revision that we will fetch the repo at.
},
},
],
"failureInfo": { # A fatal problem encountered during the execution of the build. # Output only. Contains information about the build when status=FAILURE.
"detail": "A String", # Explains the failure issue in more detail using hard-coded text.
"type": "A String", # The name of the failure.
},
"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.
"gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations.
"http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations.
"proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.
},
},
"id": "A String", # Output only. Unique identifier of the build.
"images": [ # A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.
"A String",
],
"logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.
"logsBucket": "A String", # Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
"name": "A String", # Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service.
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
"automapSubstitutions": True or False, # Option to include built-in and custom substitutions as env variables for all build steps.
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup.
"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error.
"dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.
"enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.
"env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
"A String",
],
"logStreamingOption": "A String", # Option to define build log streaming behavior to Cloud Storage.
"logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored.
"machineType": "A String", # Compute Engine machine type on which to run the build.
"pool": { # Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. # Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.
"name": "A String", # The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}
},
"pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates.
"requestedVerifyOption": "A String", # Requested verifiability options.
"secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.
"A String",
],
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.
"volumes": [ # Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.
{ # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
"name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
"path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
},
],
"workerPool": "A String", # This field deprecated; please use `pool.name` instead.
},
"projectId": "A String", # Output only. ID of the project.
"queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.
"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
"artifactManifest": "A String", # Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
"artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts to Cloud Storage.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"buildStepImages": [ # List of build step digests, in the order corresponding to build step indices.
"A String",
],
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted.
"A String",
],
"goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.
{ # A Go module artifact uploaded to Artifact Registry using the GoModule directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
"images": [ # Container images that were built as a part of the build.
{ # An image built by the pipeline.
"digest": "A String", # Docker Registry 2.0 digest.
"name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`.
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
],
"mavenArtifacts": [ # Maven artifacts uploaded to Artifact Registry at the end of the build.
{ # A Maven artifact uploaded using the MavenArtifact directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Maven Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
"npmPackages": [ # Npm packages uploaded to Artifact Registry at the end of the build.
{ # An npm package uploaded to Artifact Registry using the NpmPackage directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the npm package.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded npm package.
},
],
"numArtifacts": "A String", # Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
"pythonPackages": [ # Python artifacts uploaded to Artifact Registry at the end of the build.
{ # Artifact uploaded using the PythonPackage directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Python Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
},
"secrets": [ # Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets
{ # Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.
"kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
"secretEnv": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
"a_key": "A String",
},
},
],
"serviceAccount": "A String", # IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account.
"source": { # Location of the source in a supported storage service. # Optional. The location of the source files to build.
"connectedRepository": { # Location of the source in a 2nd-gen Google Cloud Build repository resource. # Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build.
"repository": "A String", # Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"developerConnectConfig": { # This config defines the location of a source through Developer Connect. # If provided, get the source from this Developer Connect config.
"dir": "A String", # Required. Directory, relative to the source root, in which to run the build.
"gitRepositoryLink": "A String", # Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"gitSource": { # Location of the source in any accessible Git repository. # If provided, get the source from this Git repository.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"revision": "A String", # Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.
"url": "A String", # Required. Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.
},
"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository.
"branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
"commitSha": "A String", # Explicit commit SHA to build.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"invertRegex": True or False, # Optional. Only trigger a build if the revision regex does NOT match the revision regex.
"projectId": "A String", # Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
"substitutions": { # Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
"a_key": "A String",
},
"tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
},
"storageSource": { # Location of the source in an archive file in Cloud Storage. # If provided, get the source from this location in Cloud Storage.
"bucket": "A String", # Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.
"sourceFetcher": "A String", # Optional. Option to specify the tool to fetch the source file for the build.
},
"storageSourceManifest": { # Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). # If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).
"bucket": "A String", # Required. Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source manifest. This object must be a JSON file.
},
},
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source.
"fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.
"a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
},
"resolvedConnectedRepository": { # Location of the source in a 2nd-gen Google Cloud Build repository resource. # Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build.
"repository": "A String", # Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"resolvedGitSource": { # Location of the source in any accessible Git repository. # Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"revision": "A String", # Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.
"url": "A String", # Required. Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.
},
"resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
"branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
"commitSha": "A String", # Explicit commit SHA to build.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"invertRegex": True or False, # Optional. Only trigger a build if the revision regex does NOT match the revision regex.
"projectId": "A String", # Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
"substitutions": { # Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
"a_key": "A String",
},
"tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
},
"resolvedStorageSource": { # Location of the source in an archive file in Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved.
"bucket": "A String", # Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.
"sourceFetcher": "A String", # Optional. Option to specify the tool to fetch the source file for the build.
},
"resolvedStorageSourceManifest": { # Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). # A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview.
"bucket": "A String", # Required. Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source manifest. This object must be a JSON file.
},
},
"startTime": "A String", # Output only. Time at which execution of the build was started.
"status": "A String", # Output only. Status of the build.
"statusDetail": "A String", # Output only. Customer-readable message about the current status.
"steps": [ # Required. The operations to be performed on the workspace.
{ # A step in the build pipeline.
"allowExitCodes": [ # Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.
42,
],
"allowFailure": True or False, # Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.
"args": [ # A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
"A String",
],
"automapSubstitutions": True or False, # Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.
"dir": "A String", # Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
"entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.
"env": [ # A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
"A String",
],
"exitCode": 42, # Output only. Return code from running the step.
"id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
"name": "A String", # Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
"pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.
"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.
"A String",
],
"status": "A String", # Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.
"timeout": "A String", # Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"volumes": [ # List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.
{ # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
"name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
"path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
},
],
"waitFor": [ # The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.
"A String",
],
},
],
"substitutions": { # Substitutions data for `Build` resource.
"a_key": "A String",
},
"tags": [ # Tags for annotation of a `Build`. These are not docker tags.
"A String",
],
"timeout": "A String", # Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes.
"timing": { # Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.
"a_key": { # Start and end times for a build execution phase.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
"warnings": [ # Output only. Non-fatal problems encountered during the execution of the build.
{ # A non-fatal problem encountered during the execution of the build.
"priority": "A String", # The priority for this warning.
"text": "A String", # Explanation of the warning generated.
},
],
}
parent: string, The parent resource where this build will be created. Format: `projects/{project}/locations/{location}`
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(projectId, id, name=None, x__xgafv=None)</code>
<pre>Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.
Args:
projectId: string, Required. ID of the project. (required)
id: string, Required. ID of the build. (required)
name: string, The name of the `Build` to retrieve. Format: `projects/{project}/locations/{location}/builds/{build}`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
"approval": { # BuildApproval describes a build's approval configuration, state, and result. # Output only. Describes this build's approval configuration, status, and result.
"config": { # ApprovalConfig describes configuration for manual approval of a build. # Output only. Configuration for manual approval of this build.
"approvalRequired": True or False, # Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.
},
"result": { # ApprovalResult describes the decision and associated metadata of a manual approval of a build. # Output only. Result of manual approval for this Build.
"approvalTime": "A String", # Output only. The time when the approval decision was made.
"approverAccount": "A String", # Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.
"comment": "A String", # Optional. An optional comment for this manual approval result.
"decision": "A String", # Required. The decision of this manual approval.
"url": "A String", # Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.
},
"state": "A String", # Output only. The state of this build's approval.
},
"artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
"goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.
{ # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.
"modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2
"moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5
"repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location.
"repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo
"repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project.
"sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage
},
],
"images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"mavenArtifacts": [ # A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.
{ # A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.
"artifactId": "A String", # Maven `artifactId` value used when uploading the artifact to Artifact Registry.
"groupId": "A String", # Maven `groupId` value used when uploading the artifact to Artifact Registry.
"path": "A String", # Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix.
"version": "A String", # Maven `version` value used when uploading the artifact to Artifact Registry.
},
],
"npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE.
{ # Npm package to upload to Artifact Registry upon successful completion of all build steps.
"packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix.
},
],
"objects": { # Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. # A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.
"location": "A String", # Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.
"paths": [ # Path globs used to match files in the build's workspace.
"A String",
],
"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
"pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.
{ # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.
"paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file.
"A String",
],
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix.
},
],
},
"availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables.
"inline": [ # Secrets encrypted with KMS key and the associated secret environment variable.
{ # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
"envMap": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
"a_key": "A String",
},
"kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*
},
],
"secretManager": [ # Secrets in Secret Manager and associated secret environment variable.
{ # Pairs a secret environment variable with a SecretVersion in Secret Manager.
"env": "A String", # Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.
"versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*
},
],
},
"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.
"createTime": "A String", # Output only. Time at which the request to create the build was received.
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.
{ # A dependency that the Cloud Build worker will fetch before executing user steps.
"empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well).
"gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency.
"depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history).
"destPath": "A String", # Required. Where should the files be placed on the worker.
"recurseSubmodules": True or False, # Optional. True if submodules should be fetched too (default false).
"repository": { # A repository for a git source. # Required. The kind of repo (url or dev connect).
"developerConnect": "A String", # The Developer Connect Git repository link formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`
"url": "A String", # Location of the Git repository.
},
"revision": "A String", # Required. The revision that we will fetch the repo at.
},
},
],
"failureInfo": { # A fatal problem encountered during the execution of the build. # Output only. Contains information about the build when status=FAILURE.
"detail": "A String", # Explains the failure issue in more detail using hard-coded text.
"type": "A String", # The name of the failure.
},
"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.
"gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations.
"http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations.
"proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.
},
},
"id": "A String", # Output only. Unique identifier of the build.
"images": [ # A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.
"A String",
],
"logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.
"logsBucket": "A String", # Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
"name": "A String", # Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service.
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
"automapSubstitutions": True or False, # Option to include built-in and custom substitutions as env variables for all build steps.
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup.
"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error.
"dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.
"enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.
"env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
"A String",
],
"logStreamingOption": "A String", # Option to define build log streaming behavior to Cloud Storage.
"logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored.
"machineType": "A String", # Compute Engine machine type on which to run the build.
"pool": { # Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. # Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.
"name": "A String", # The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}
},
"pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates.
"requestedVerifyOption": "A String", # Requested verifiability options.
"secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.
"A String",
],
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.
"volumes": [ # Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.
{ # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
"name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
"path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
},
],
"workerPool": "A String", # This field deprecated; please use `pool.name` instead.
},
"projectId": "A String", # Output only. ID of the project.
"queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.
"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
"artifactManifest": "A String", # Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
"artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts to Cloud Storage.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"buildStepImages": [ # List of build step digests, in the order corresponding to build step indices.
"A String",
],
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted.
"A String",
],
"goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.
{ # A Go module artifact uploaded to Artifact Registry using the GoModule directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
"images": [ # Container images that were built as a part of the build.
{ # An image built by the pipeline.
"digest": "A String", # Docker Registry 2.0 digest.
"name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`.
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
],
"mavenArtifacts": [ # Maven artifacts uploaded to Artifact Registry at the end of the build.
{ # A Maven artifact uploaded using the MavenArtifact directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Maven Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
"npmPackages": [ # Npm packages uploaded to Artifact Registry at the end of the build.
{ # An npm package uploaded to Artifact Registry using the NpmPackage directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the npm package.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded npm package.
},
],
"numArtifacts": "A String", # Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
"pythonPackages": [ # Python artifacts uploaded to Artifact Registry at the end of the build.
{ # Artifact uploaded using the PythonPackage directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Python Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
},
"secrets": [ # Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets
{ # Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.
"kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
"secretEnv": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
"a_key": "A String",
},
},
],
"serviceAccount": "A String", # IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account.
"source": { # Location of the source in a supported storage service. # Optional. The location of the source files to build.
"connectedRepository": { # Location of the source in a 2nd-gen Google Cloud Build repository resource. # Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build.
"repository": "A String", # Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"developerConnectConfig": { # This config defines the location of a source through Developer Connect. # If provided, get the source from this Developer Connect config.
"dir": "A String", # Required. Directory, relative to the source root, in which to run the build.
"gitRepositoryLink": "A String", # Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"gitSource": { # Location of the source in any accessible Git repository. # If provided, get the source from this Git repository.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"revision": "A String", # Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.
"url": "A String", # Required. Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.
},
"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository.
"branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
"commitSha": "A String", # Explicit commit SHA to build.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"invertRegex": True or False, # Optional. Only trigger a build if the revision regex does NOT match the revision regex.
"projectId": "A String", # Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
"substitutions": { # Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
"a_key": "A String",
},
"tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
},
"storageSource": { # Location of the source in an archive file in Cloud Storage. # If provided, get the source from this location in Cloud Storage.
"bucket": "A String", # Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.
"sourceFetcher": "A String", # Optional. Option to specify the tool to fetch the source file for the build.
},
"storageSourceManifest": { # Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). # If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).
"bucket": "A String", # Required. Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source manifest. This object must be a JSON file.
},
},
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source.
"fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.
"a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
},
"resolvedConnectedRepository": { # Location of the source in a 2nd-gen Google Cloud Build repository resource. # Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build.
"repository": "A String", # Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"resolvedGitSource": { # Location of the source in any accessible Git repository. # Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"revision": "A String", # Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.
"url": "A String", # Required. Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.
},
"resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
"branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
"commitSha": "A String", # Explicit commit SHA to build.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"invertRegex": True or False, # Optional. Only trigger a build if the revision regex does NOT match the revision regex.
"projectId": "A String", # Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
"substitutions": { # Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
"a_key": "A String",
},
"tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
},
"resolvedStorageSource": { # Location of the source in an archive file in Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved.
"bucket": "A String", # Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.
"sourceFetcher": "A String", # Optional. Option to specify the tool to fetch the source file for the build.
},
"resolvedStorageSourceManifest": { # Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). # A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview.
"bucket": "A String", # Required. Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source manifest. This object must be a JSON file.
},
},
"startTime": "A String", # Output only. Time at which execution of the build was started.
"status": "A String", # Output only. Status of the build.
"statusDetail": "A String", # Output only. Customer-readable message about the current status.
"steps": [ # Required. The operations to be performed on the workspace.
{ # A step in the build pipeline.
"allowExitCodes": [ # Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.
42,
],
"allowFailure": True or False, # Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.
"args": [ # A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
"A String",
],
"automapSubstitutions": True or False, # Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.
"dir": "A String", # Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
"entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.
"env": [ # A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
"A String",
],
"exitCode": 42, # Output only. Return code from running the step.
"id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
"name": "A String", # Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
"pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.
"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.
"A String",
],
"status": "A String", # Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.
"timeout": "A String", # Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"volumes": [ # List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.
{ # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
"name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
"path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
},
],
"waitFor": [ # The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.
"A String",
],
},
],
"substitutions": { # Substitutions data for `Build` resource.
"a_key": "A String",
},
"tags": [ # Tags for annotation of a `Build`. These are not docker tags.
"A String",
],
"timeout": "A String", # Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes.
"timing": { # Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.
"a_key": { # Start and end times for a build execution phase.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
"warnings": [ # Output only. Non-fatal problems encountered during the execution of the build.
{ # A non-fatal problem encountered during the execution of the build.
"priority": "A String", # The priority for this warning.
"text": "A String", # Explanation of the warning generated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectId, filter=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)</code>
<pre>Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
Args:
projectId: string, Required. ID of the project. (required)
filter: string, The raw filter text to constrain the results.
pageSize: integer, Number of results to return in the list.
pageToken: string, The page token for the next page of Builds. If unspecified, the first page of results is returned. If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results. See https://google.aip.dev/158 for more.
parent: string, The parent of the collection of `Builds`. Format: `projects/{project}/locations/{location}`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response including listed builds.
"builds": [ # Builds will be sorted by `create_time`, descending.
{ # A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
"approval": { # BuildApproval describes a build's approval configuration, state, and result. # Output only. Describes this build's approval configuration, status, and result.
"config": { # ApprovalConfig describes configuration for manual approval of a build. # Output only. Configuration for manual approval of this build.
"approvalRequired": True or False, # Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.
},
"result": { # ApprovalResult describes the decision and associated metadata of a manual approval of a build. # Output only. Result of manual approval for this Build.
"approvalTime": "A String", # Output only. The time when the approval decision was made.
"approverAccount": "A String", # Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.
"comment": "A String", # Optional. An optional comment for this manual approval result.
"decision": "A String", # Required. The decision of this manual approval.
"url": "A String", # Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.
},
"state": "A String", # Output only. The state of this build's approval.
},
"artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
"goModules": [ # Optional. A list of Go modules to be uploaded to Artifact Registry upon successful completion of all build steps. If any objects fail to be pushed, the build is marked FAILURE.
{ # Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.
"modulePath": "A String", # Optional. The Go module's "module path". e.g. example.com/foo/v2
"moduleVersion": "A String", # Optional. The Go module's semantic version in the form vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by appending a dash and dot separated ASCII alphanumeric characters and hyphens. e.g. v0.2.3-alpha.x.12m.5
"repositoryLocation": "A String", # Optional. Location of the Artifact Registry repository. i.e. us-east1 Defaults to the build’s location.
"repositoryName": "A String", # Optional. Artifact Registry repository name. Specified Go modules will be zipped and uploaded to Artifact Registry with this location as a prefix. e.g. my-go-repo
"repositoryProjectId": "A String", # Optional. Project ID of the Artifact Registry repository. Defaults to the build project.
"sourcePath": "A String", # Optional. Source path of the go.mod file in the build's workspace. If not specified, this will default to the current directory. e.g. ~/code/go/mypackage
},
],
"images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
"mavenArtifacts": [ # A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.
{ # A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.
"artifactId": "A String", # Maven `artifactId` value used when uploading the artifact to Artifact Registry.
"groupId": "A String", # Maven `groupId` value used when uploading the artifact to Artifact Registry.
"path": "A String", # Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix.
"version": "A String", # Maven `version` value used when uploading the artifact to Artifact Registry.
},
],
"npmPackages": [ # A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE.
{ # Npm package to upload to Artifact Registry upon successful completion of all build steps.
"packagePath": "A String", # Optional. Path to the package.json. e.g. workspace/path/to/package Only one of `archive` or `package_path` can be specified.
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix.
},
],
"objects": { # Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. # A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.
"location": "A String", # Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.
"paths": [ # Path globs used to match files in the build's workspace.
"A String",
],
"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
"pythonPackages": [ # A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.
{ # Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.
"paths": [ # Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file.
"A String",
],
"repository": "A String", # Artifact Registry repository, in the form "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix.
},
],
},
"availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables.
"inline": [ # Secrets encrypted with KMS key and the associated secret environment variable.
{ # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
"envMap": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
"a_key": "A String",
},
"kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*
},
],
"secretManager": [ # Secrets in Secret Manager and associated secret environment variable.
{ # Pairs a secret environment variable with a SecretVersion in Secret Manager.
"env": "A String", # Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.
"versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*
},
],
},
"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.
"createTime": "A String", # Output only. Time at which the request to create the build was received.
"dependencies": [ # Optional. Dependencies that the Cloud Build worker will fetch before executing user steps.
{ # A dependency that the Cloud Build worker will fetch before executing user steps.
"empty": True or False, # If set to true disable all dependency fetching (ignoring the default source as well).
"gitSource": { # Represents a git repository as a build dependency. # Represents a git repository as a build dependency.
"depth": "A String", # Optional. How much history should be fetched for the build (default 1, -1 for all history).
"destPath": "A String", # Required. Where should the files be placed on the worker.
"recurseSubmodules": True or False, # Optional. True if submodules should be fetched too (default false).
"repository": { # A repository for a git source. # Required. The kind of repo (url or dev connect).
"developerConnect": "A String", # The Developer Connect Git repository link formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`
"url": "A String", # Location of the Git repository.
},
"revision": "A String", # Required. The revision that we will fetch the repo at.
},
},
],
"failureInfo": { # A fatal problem encountered during the execution of the build. # Output only. Contains information about the build when status=FAILURE.
"detail": "A String", # Explains the failure issue in more detail using hard-coded text.
"type": "A String", # The name of the failure.
},
"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.
"gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations.
"http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations.
"proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.
},
},
"id": "A String", # Output only. Unique identifier of the build.
"images": [ # A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.
"A String",
],
"logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.
"logsBucket": "A String", # Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
"name": "A String", # Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service.
"options": { # Optional arguments to enable specific features of builds. # Special options for this build.
"automapSubstitutions": True or False, # Option to include built-in and custom substitutions as env variables for all build steps.
"defaultLogsBucketBehavior": "A String", # Optional. Option to specify how default logs buckets are setup.
"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error.
"dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.
"enableStructuredLogging": True or False, # Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.
"env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
"A String",
],
"logStreamingOption": "A String", # Option to define build log streaming behavior to Cloud Storage.
"logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored.
"machineType": "A String", # Compute Engine machine type on which to run the build.
"pool": { # Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information. # Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.
"name": "A String", # The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}
},
"pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates.
"requestedVerifyOption": "A String", # Requested verifiability options.
"secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.
"A String",
],
"sourceProvenanceHash": [ # Requested hash for SourceProvenance.
"A String",
],
"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.
"volumes": [ # Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.
{ # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
"name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
"path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
},
],
"workerPool": "A String", # This field deprecated; please use `pool.name` instead.
},
"projectId": "A String", # Output only. ID of the project.
"queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.
"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
"artifactManifest": "A String", # Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
"artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts to Cloud Storage.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"buildStepImages": [ # List of build step digests, in the order corresponding to build step indices.
"A String",
],
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted.
"A String",
],
"goModules": [ # Optional. Go module artifacts uploaded to Artifact Registry at the end of the build.
{ # A Go module artifact uploaded to Artifact Registry using the GoModule directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Go Module Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
"images": [ # Container images that were built as a part of the build.
{ # An image built by the pipeline.
"digest": "A String", # Docker Registry 2.0 digest.
"name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`.
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
],
"mavenArtifacts": [ # Maven artifacts uploaded to Artifact Registry at the end of the build.
{ # A Maven artifact uploaded using the MavenArtifact directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Maven Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
"npmPackages": [ # Npm packages uploaded to Artifact Registry at the end of the build.
{ # An npm package uploaded to Artifact Registry using the NpmPackage directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the npm package.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded npm package.
},
],
"numArtifacts": "A String", # Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
"pythonPackages": [ # Python artifacts uploaded to Artifact Registry at the end of the build.
{ # Artifact uploaded using the PythonPackage directive.
"fileHashes": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Hash types and values of the Python Artifact.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified artifact.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"uri": "A String", # URI of the uploaded artifact.
},
],
},
"secrets": [ # Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets
{ # Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.
"kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
"secretEnv": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
"a_key": "A String",
},
},
],
"serviceAccount": "A String", # IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account.
"source": { # Location of the source in a supported storage service. # Optional. The location of the source files to build.
"connectedRepository": { # Location of the source in a 2nd-gen Google Cloud Build repository resource. # Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build.
"repository": "A String", # Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"developerConnectConfig": { # This config defines the location of a source through Developer Connect. # If provided, get the source from this Developer Connect config.
"dir": "A String", # Required. Directory, relative to the source root, in which to run the build.
"gitRepositoryLink": "A String", # Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"gitSource": { # Location of the source in any accessible Git repository. # If provided, get the source from this Git repository.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"revision": "A String", # Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.
"url": "A String", # Required. Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.
},
"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository.
"branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
"commitSha": "A String", # Explicit commit SHA to build.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"invertRegex": True or False, # Optional. Only trigger a build if the revision regex does NOT match the revision regex.
"projectId": "A String", # Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
"substitutions": { # Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
"a_key": "A String",
},
"tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
},
"storageSource": { # Location of the source in an archive file in Cloud Storage. # If provided, get the source from this location in Cloud Storage.
"bucket": "A String", # Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.
"sourceFetcher": "A String", # Optional. Option to specify the tool to fetch the source file for the build.
},
"storageSourceManifest": { # Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). # If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).
"bucket": "A String", # Required. Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source manifest. This object must be a JSON file.
},
},
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source.
"fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.
"a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
"fileHash": [ # Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
],
},
},
"resolvedConnectedRepository": { # Location of the source in a 2nd-gen Google Cloud Build repository resource. # Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build.
"repository": "A String", # Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`.
"revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
},
"resolvedGitSource": { # Location of the source in any accessible Git repository. # Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"revision": "A String", # Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch the revision from the Git repository; therefore make sure that the string you provide for `revision` is parsable by the command. For information on string values accepted by `git fetch`, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on `git fetch`, see https://git-scm.com/docs/git-fetch.
"url": "A String", # Required. Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote.
},
"resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
"branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
"commitSha": "A String", # Explicit commit SHA to build.
"dir": "A String", # Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
"invertRegex": True or False, # Optional. Only trigger a build if the revision regex does NOT match the revision regex.
"projectId": "A String", # Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
"repoName": "A String", # Required. Name of the Cloud Source Repository.
"substitutions": { # Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
"a_key": "A String",
},
"tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
},
"resolvedStorageSource": { # Location of the source in an archive file in Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved.
"bucket": "A String", # Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.
"sourceFetcher": "A String", # Optional. Option to specify the tool to fetch the source file for the build.
},
"resolvedStorageSourceManifest": { # Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). # A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview.
"bucket": "A String", # Required. Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
"generation": "A String", # Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
"object": "A String", # Required. Cloud Storage object containing the source manifest. This object must be a JSON file.
},
},
"startTime": "A String", # Output only. Time at which execution of the build was started.
"status": "A String", # Output only. Status of the build.
"statusDetail": "A String", # Output only. Customer-readable message about the current status.
"steps": [ # Required. The operations to be performed on the workspace.
{ # A step in the build pipeline.
"allowExitCodes": [ # Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.
42,
],
"allowFailure": True or False, # Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.
"args": [ # A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
"A String",
],
"automapSubstitutions": True or False, # Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.
"dir": "A String", # Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
"entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.
"env": [ # A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
"A String",
],
"exitCode": 42, # Output only. Return code from running the step.
"id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
"name": "A String", # Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
"pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.
"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.
"A String",
],
"status": "A String", # Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.
"timeout": "A String", # Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
"volumes": [ # List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.
{ # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
"name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
"path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
},
],
"waitFor": [ # The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.
"A String",
],
},
],
"substitutions": { # Substitutions data for `Build` resource.
"a_key": "A String",
},
"tags": [ # Tags for annotation of a `Build`. These are not docker tags.
"A String",
],
"timeout": "A String", # Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes.
"timing": { # Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.
"a_key": { # Start and end times for a build execution phase.
"endTime": "A String", # End of time span.
"startTime": "A String", # Start of time span.
},
},
"warnings": [ # Output only. Non-fatal problems encountered during the execution of the build.
{ # A non-fatal problem encountered during the execution of the build.
"priority": "A String", # The priority for this warning.
"text": "A String", # Explanation of the warning generated.
},
],
},
],
"nextPageToken": "A String", # Token to receive the next page of results. This will be absent if the end of the response list has been reached.
}</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="retry">retry(projectId, id, body=None, x__xgafv=None)</code>
<pre>Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
Args:
projectId: string, Required. ID of the project. (required)
id: string, Required. Build ID of the original build. (required)
body: object, The request body.
The object takes the form of:
{ # Specifies a build to retry.
"id": "A String", # Required. Build ID of the original build.
"name": "A String", # The name of the `Build` to retry. Format: `projects/{project}/locations/{location}/builds/{build}`
"projectId": "A String", # Required. ID of the project.
}
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>
</body></html>
|