Skip to content

Commit 30c1222

Browse files
yoshi-automationyoshi-automation
committed
feat(cloudbuild): update the api
#### cloudbuild:v1 The following keys were added: - resources.projects.resources.builds.methods.approve (Total Keys: 12) - resources.projects.resources.locations.resources.builds.methods.approve (Total Keys: 12) - schemas.ApprovalConfig (Total Keys: 3) - schemas.ApprovalResult (Total Keys: 9) - schemas.ApproveBuildRequest (Total Keys: 3) - schemas.Build.properties.approval (Total Keys: 2) - schemas.BuildApproval (Total Keys: 8) - schemas.BuildStep.properties.script.type (Total Keys: 1) - schemas.BuildTrigger.properties.approvalConfig.$ref (Total Keys: 1) - schemas.BuildTrigger.properties.gitFileSource.$ref (Total Keys: 1) - schemas.GitFileSource (Total Keys: 5) #### cloudbuild:v1alpha1 The following keys were added: - schemas.ApprovalConfig (Total Keys: 3) - schemas.ApprovalResult (Total Keys: 9) - schemas.Build.properties.approval (Total Keys: 2) - schemas.BuildApproval (Total Keys: 8) - schemas.BuildStep.properties.script.type (Total Keys: 1) #### cloudbuild:v1alpha2 The following keys were added: - schemas.ApprovalConfig (Total Keys: 3) - schemas.ApprovalResult (Total Keys: 9) - schemas.Build.properties.approval (Total Keys: 2) - schemas.BuildApproval (Total Keys: 8) - schemas.BuildStep.properties.script.type (Total Keys: 1) #### cloudbuild:v1beta1 The following keys were added: - schemas.ApprovalConfig (Total Keys: 3) - schemas.ApprovalResult (Total Keys: 9) - schemas.Build.properties.approval (Total Keys: 2) - schemas.BuildApproval (Total Keys: 8) - schemas.BuildStep.properties.script.type (Total Keys: 1)
1 parent 08e8f4f commit 30c1222

8 files changed

+1032
-34
lines changed

‎docs/dyn/cloudbuild_v1.projects.builds.html

Lines changed: 107 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/dyn/cloudbuild_v1.projects.locations.builds.html

Lines changed: 107 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/dyn/cloudbuild_v1.projects.locations.triggers.html

Lines changed: 150 additions & 12 deletions
Large diffs are not rendered by default.

‎docs/dyn/cloudbuild_v1.projects.triggers.html

Lines changed: 150 additions & 12 deletions
Large diffs are not rendered by default.

‎googleapiclient/discovery_cache/documents/cloudbuild.v1.json

Lines changed: 212 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,34 @@
166166
"resources": {
167167
"builds": {
168168
"methods": {
169+
"approve": {
170+
"description": "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.",
171+
"flatPath": "v1/projects/{projectsId}/builds/{buildsId}:approve",
172+
"httpMethod": "POST",
173+
"id": "cloudbuild.projects.builds.approve",
174+
"parameterOrder": [
175+
"name"
176+
],
177+
"parameters": {
178+
"name": {
179+
"description": "Required. Name of the target build. For example: \"projects/{$project_id}/builds/{$build_id}\"",
180+
"location": "path",
181+
"pattern": "^projects/[^/]+/builds/[^/]+$",
182+
"required": true,
183+
"type": "string"
184+
}
185+
},
186+
"path": "v1/{+name}:approve",
187+
"request": {
188+
"$ref": "ApproveBuildRequest"
189+
},
190+
"response": {
191+
"$ref": "Operation"
192+
},
193+
"scopes": [
194+
"https://www.googleapis.com/auth/cloud-platform"
195+
]
196+
},
169197
"cancel": {
170198
"description": "Cancels a build in progress.",
171199
"flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
@@ -524,6 +552,34 @@
524552
"resources": {
525553
"builds": {
526554
"methods": {
555+
"approve": {
556+
"description": "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.",
557+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:approve",
558+
"httpMethod": "POST",
559+
"id": "cloudbuild.projects.locations.builds.approve",
560+
"parameterOrder": [
561+
"name"
562+
],
563+
"parameters": {
564+
"name": {
565+
"description": "Required. Name of the target build. For example: \"projects/{$project_id}/builds/{$build_id}\"",
566+
"location": "path",
567+
"pattern": "^projects/[^/]+/locations/[^/]+/builds/[^/]+$",
568+
"required": true,
569+
"type": "string"
570+
}
571+
},
572+
"path": "v1/{+name}:approve",
573+
"request": {
574+
"$ref": "ApproveBuildRequest"
575+
},
576+
"response": {
577+
"$ref": "Operation"
578+
},
579+
"scopes": [
580+
"https://www.googleapis.com/auth/cloud-platform"
581+
]
582+
},
527583
"cancel": {
528584
"description": "Cancels a build in progress.",
529585
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:cancel",
@@ -1652,9 +1708,71 @@
16521708
}
16531709
}
16541710
},
1655-
"revision": "20210730",
1711+
"revision": "20210803",
16561712
"rootUrl": "https://cloudbuild.googleapis.com/",
16571713
"schemas": {
1714+
"ApprovalConfig": {
1715+
"description": "ApprovalConfig describes configuration for manual approval of a build.",
1716+
"id": "ApprovalConfig",
1717+
"properties": {
1718+
"approvalRequired": {
1719+
"description": "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.",
1720+
"type": "boolean"
1721+
}
1722+
},
1723+
"type": "object"
1724+
},
1725+
"ApprovalResult": {
1726+
"description": "ApprovalResult describes the decision and associated metadata of a manual approval of a build.",
1727+
"id": "ApprovalResult",
1728+
"properties": {
1729+
"approvalTime": {
1730+
"description": "Output only. The time when the approval decision was made.",
1731+
"format": "google-datetime",
1732+
"readOnly": true,
1733+
"type": "string"
1734+
},
1735+
"approverAccount": {
1736+
"description": "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 (the user's actual email that is tied to their GAIA ID may have changed). This field is not stored, rather, it is calculated on the fly using approver_id.",
1737+
"readOnly": true,
1738+
"type": "string"
1739+
},
1740+
"comment": {
1741+
"description": "Optional. An optional comment for this manual approval result.",
1742+
"type": "string"
1743+
},
1744+
"decision": {
1745+
"description": "Required. The decision of this manual approval.",
1746+
"enum": [
1747+
"DECISION_UNSPECIFIED",
1748+
"APPROVED",
1749+
"REJECTED"
1750+
],
1751+
"enumDescriptions": [
1752+
"Default enum type. This should not be used.",
1753+
"Build is approved.",
1754+
"Build is rejected."
1755+
],
1756+
"type": "string"
1757+
},
1758+
"url": {
1759+
"description": "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.",
1760+
"type": "string"
1761+
}
1762+
},
1763+
"type": "object"
1764+
},
1765+
"ApproveBuildRequest": {
1766+
"description": "Request to approve or reject a pending build.",
1767+
"id": "ApproveBuildRequest",
1768+
"properties": {
1769+
"approvalResult": {
1770+
"$ref": "ApprovalResult",
1771+
"description": "Approval decision and metadata."
1772+
}
1773+
},
1774+
"type": "object"
1775+
},
16581776
"ArtifactObjects": {
16591777
"description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.",
16601778
"id": "ArtifactObjects",
@@ -1718,6 +1836,11 @@
17181836
"description": "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. - $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.",
17191837
"id": "Build",
17201838
"properties": {
1839+
"approval": {
1840+
"$ref": "BuildApproval",
1841+
"description": "Output only. Describes this build's approval configuration, status, and result.",
1842+
"readOnly": true
1843+
},
17211844
"artifacts": {
17221845
"$ref": "Artifacts",
17231846
"description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps."
@@ -1823,6 +1946,7 @@
18231946
"description": "Output only. Status of the build.",
18241947
"enum": [
18251948
"STATUS_UNKNOWN",
1949+
"PENDING",
18261950
"QUEUED",
18271951
"WORKING",
18281952
"SUCCESS",
@@ -1834,6 +1958,7 @@
18341958
],
18351959
"enumDescriptions": [
18361960
"Status of the build is unknown.",
1961+
"Build has been created and is pending execution and queuing. It has not been queued.",
18371962
"Build or step is queued; work has not yet begun.",
18381963
"Build or step is being executed.",
18391964
"Build or step finished successfully.",
@@ -1896,6 +2021,42 @@
18962021
},
18972022
"type": "object"
18982023
},
2024+
"BuildApproval": {
2025+
"description": "BuildApproval describes a build's approval configuration, state, and result.",
2026+
"id": "BuildApproval",
2027+
"properties": {
2028+
"config": {
2029+
"$ref": "ApprovalConfig",
2030+
"description": "Output only. Configuration for manual approval of this build.",
2031+
"readOnly": true
2032+
},
2033+
"result": {
2034+
"$ref": "ApprovalResult",
2035+
"description": "Output only. Result of manual approval for this Build.",
2036+
"readOnly": true
2037+
},
2038+
"state": {
2039+
"description": "Output only. The state of this build's approval.",
2040+
"enum": [
2041+
"STATE_UNSPECIFIED",
2042+
"PENDING",
2043+
"APPROVED",
2044+
"REJECTED",
2045+
"CANCELLED"
2046+
],
2047+
"enumDescriptions": [
2048+
"Default enum type. This should not be used.",
2049+
"Build approval is pending.",
2050+
"Build approval has been approved.",
2051+
"Build approval has been rejected.",
2052+
"Build was cancelled while it was still pending approval."
2053+
],
2054+
"readOnly": true,
2055+
"type": "string"
2056+
}
2057+
},
2058+
"type": "object"
2059+
},
18992060
"BuildOperationMetadata": {
19002061
"description": "Metadata for build operations.",
19012062
"id": "BuildOperationMetadata",
@@ -2084,6 +2245,10 @@
20842245
"description": "Output only. Stores timing information for pulling this build step's builder image only.",
20852246
"readOnly": true
20862247
},
2248+
"script": {
2249+
"description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.",
2250+
"type": "string"
2251+
},
20872252
"secretEnv": {
20882253
"description": "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`.",
20892254
"items": {
@@ -2095,6 +2260,7 @@
20952260
"description": "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.",
20962261
"enum": [
20972262
"STATUS_UNKNOWN",
2263+
"PENDING",
20982264
"QUEUED",
20992265
"WORKING",
21002266
"SUCCESS",
@@ -2106,6 +2272,7 @@
21062272
],
21072273
"enumDescriptions": [
21082274
"Status of the build is unknown.",
2275+
"Build has been created and is pending execution and queuing. It has not been queued.",
21092276
"Build or step is queued; work has not yet begun.",
21102277
"Build or step is being executed.",
21112278
"Build or step finished successfully.",
@@ -2149,6 +2316,10 @@
21492316
"description": "Configuration for an automated build in response to source repository changes.",
21502317
"id": "BuildTrigger",
21512318
"properties": {
2319+
"approvalConfig": {
2320+
"$ref": "ApprovalConfig",
2321+
"description": "Configuration for manual approval to start a build invocation of this BuildTrigger."
2322+
},
21522323
"autodetect": {
21532324
"description": "Autodetect build configuration. The following precedence is used (case insensitive): 1. cloudbuild.yaml 2. cloudbuild.yml 3. cloudbuild.json 4. Dockerfile Currently only available for GitHub App Triggers.",
21542325
"type": "boolean"
@@ -2176,9 +2347,13 @@
21762347
"type": "string"
21772348
},
21782349
"filter": {
2179-
"description": "Optional. A Common Expression Language string.",
2350+
"description": "A Common Expression Language string.",
21802351
"type": "string"
21812352
},
2353+
"gitFileSource": {
2354+
"$ref": "GitFileSource",
2355+
"description": "The file source describing the local or remote Build template."
2356+
},
21822357
"github": {
21832358
"$ref": "GitHubEventsConfig",
21842359
"description": "GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`."
@@ -2215,7 +2390,7 @@
22152390
"type": "string"
22162391
},
22172392
"serviceAccount": {
2218-
"description": "Optional. The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`",
2393+
"description": "The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`",
22192394
"type": "string"
22202395
},
22212396
"sourceToBuild": {
@@ -2429,6 +2604,39 @@
24292604
},
24302605
"type": "object"
24312606
},
2607+
"GitFileSource": {
2608+
"description": "GitFileSource describes a file within a (possibly remote) code repository.",
2609+
"id": "GitFileSource",
2610+
"properties": {
2611+
"path": {
2612+
"description": "The path of the file, with the repo root as the root of the path.",
2613+
"type": "string"
2614+
},
2615+
"repoType": {
2616+
"description": "See RepoType above.",
2617+
"enum": [
2618+
"UNKNOWN",
2619+
"CLOUD_SOURCE_REPOSITORIES",
2620+
"GITHUB"
2621+
],
2622+
"enumDescriptions": [
2623+
"The default, unknown repo type.",
2624+
"A Google Cloud Source Repositories-hosted repo.",
2625+
"A GitHub-hosted repo not necessarily on \"github.com\" (i.e. GitHub Enterprise)."
2626+
],
2627+
"type": "string"
2628+
},
2629+
"revision": {
2630+
"description": "The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the filename (optional). This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions If unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path.",
2631+
"type": "string"
2632+
},
2633+
"uri": {
2634+
"description": "The URI of the repo (optional). If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path.",
2635+
"type": "string"
2636+
}
2637+
},
2638+
"type": "object"
2639+
},
24322640
"GitHubEnterpriseConfig": {
24332641
"description": "GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.",
24342642
"id": "GitHubEnterpriseConfig",
@@ -2953,7 +3161,7 @@
29533161
"type": "string"
29543162
},
29553163
"cancelRequested": {
2956-
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
3164+
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
29573165
"readOnly": true,
29583166
"type": "boolean"
29593167
},

0 commit comments

Comments
 (0)