| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 75 | <h1><a href="cloudbuild_v1.html">Cloud Build API</a> . <a href="cloudbuild_v1.projects.html">projects</a> . <a href="cloudbuild_v1.projects.triggers.html">triggers</a></h1> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(projectId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 82 | <p class="firstline">Creates a new `BuildTrigger`. This API is experimental.</p> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(projectId, triggerId, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 85 | <p class="firstline">Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental.</p> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(projectId, triggerId, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 88 | <p class="firstline">Returns information about a `BuildTrigger`. This API is experimental.</p> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 90 | <code><a href="#list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <p class="firstline">Lists existing `BuildTrigger`s. This API is experimental.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 95 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#patch">patch(projectId, triggerId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 97 | <p class="firstline">Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 99 | <code><a href="#run">run(projectId, triggerId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="firstline">Runs a `BuildTrigger` at a particular source revision.</p> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 101 | <p class="toc_element"> |
| 102 | <code><a href="#webhook">webhook(projectId, trigger, body=None, secret=None, x__xgafv=None)</a></code></p> |
| 103 | <p class="firstline">ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.</p> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 104 | <h3>Method Details</h3> |
| 105 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 106 | <code class="details" id="close">close()</code> |
| 107 | <pre>Close httplib2 connections.</pre> |
| 108 | </div> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 109 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 110 | <div class="method"> |
| 111 | <code class="details" id="create">create(projectId, body=None, x__xgafv=None)</code> |
| 112 | <pre>Creates a new `BuildTrigger`. This API is experimental. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 113 | |
| 114 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 115 | projectId: string, Required. ID of the project for which to configure automatic builds. (required) |
| 116 | body: object, The request body. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 117 | The object takes the form of: |
| 118 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 119 | { # Configuration for an automated build in response to source repository changes. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 120 | "build": { # 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. # Contents of the build template. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 121 | "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. |
| 122 | "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. |
| 123 | "A String", |
| 124 | ], |
| 125 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 126 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 127 | "paths": [ # Path globs used to match files in the build's workspace. |
| 128 | "A String", |
| 129 | ], |
| 130 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 131 | "endTime": "A String", # End of time span. |
| 132 | "startTime": "A String", # Start of time span. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 133 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 134 | }, |
| 135 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 136 | "availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables. |
| 137 | "inline": [ # Secrets encrypted with KMS key and the associated secret environment variable. |
| 138 | { # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. |
| 139 | "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. |
| 140 | "a_key": "A String", |
| 141 | }, |
| 142 | "kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* |
| 143 | }, |
| 144 | ], |
| 145 | "secretManager": [ # Secrets in Secret Manager and associated secret environment variable. |
| 146 | { # Pairs a secret environment variable with a SecretVersion in Secret Manager. |
| 147 | "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. |
| 148 | "versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/* |
| 149 | }, |
| 150 | ], |
| 151 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 152 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 153 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 154 | "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. |
| 155 | "id": "A String", # Output only. Unique identifier of the build. |
| 156 | "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`. |
| 157 | "A String", |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 158 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 159 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 160 | "logsBucket": "A String", # Google 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`. |
| 161 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 162 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 163 | "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 1000GB; builds that request more than the maximum are rejected with an error. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 164 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 165 | "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". |
| 166 | "A String", |
| 167 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 168 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| 169 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| 170 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 171 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 172 | "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. |
| 173 | "A String", |
| 174 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 175 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 176 | "A String", |
| 177 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 178 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 179 | "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. |
| 180 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 181 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 182 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 183 | }, |
| 184 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 185 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 186 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 187 | "projectId": "A String", # Output only. ID of the project. |
| 188 | "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. |
| 189 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 190 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 191 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 192 | "endTime": "A String", # End of time span. |
| 193 | "startTime": "A String", # Start of time span. |
| 194 | }, |
| 195 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 196 | "A String", |
| 197 | ], |
| 198 | "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 4KB of data is stored. |
| 199 | "A String", |
| 200 | ], |
| 201 | "images": [ # Container images that were built as a part of the build. |
| 202 | { # An image built by the pipeline. |
| 203 | "digest": "A String", # Docker Registry 2.0 digest. |
| 204 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 205 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 206 | "endTime": "A String", # End of time span. |
| 207 | "startTime": "A String", # Start of time span. |
| 208 | }, |
| 209 | }, |
| 210 | ], |
| 211 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 212 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 213 | "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 |
| 214 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 215 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 216 | "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. |
| 217 | "a_key": "A String", |
| 218 | }, |
| 219 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 220 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 221 | "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. This field is in beta. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 222 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| 223 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 224 | "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 |
| 225 | "commitSha": "A String", # Explicit commit SHA to build. |
| 226 | "dir": "A String", # 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. |
| 227 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 228 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 229 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 230 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 231 | "a_key": "A String", |
| 232 | }, |
| 233 | "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 |
| 234 | }, |
| 235 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 236 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 237 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 238 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 239 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 240 | }, |
| 241 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 242 | "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. |
| 243 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 244 | "fileHash": [ # Collection of file hashes. |
| 245 | { # Container message for hash values. |
| 246 | "type": "A String", # The type of hash that was performed. |
| 247 | "value": "A String", # The hash value. |
| 248 | }, |
| 249 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 250 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 251 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 252 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 253 | "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 |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 254 | "commitSha": "A String", # Explicit commit SHA to build. |
| 255 | "dir": "A String", # 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. |
| 256 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 257 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 258 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 259 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 260 | "a_key": "A String", |
| 261 | }, |
| 262 | "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 |
| 263 | }, |
| 264 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 265 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 266 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 267 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 268 | }, |
| 269 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 270 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 271 | "status": "A String", # Output only. Status of the build. |
| 272 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 273 | "steps": [ # Required. The operations to be performed on the workspace. |
| 274 | { # A step in the build pipeline. |
| 275 | "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. |
| 276 | "A String", |
| 277 | ], |
| 278 | "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. |
| 279 | "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. |
| 280 | "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". |
| 281 | "A String", |
| 282 | ], |
| 283 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 284 | "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. |
| 285 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 286 | "endTime": "A String", # End of time span. |
| 287 | "startTime": "A String", # Start of time span. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 288 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 289 | "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`. |
| 290 | "A String", |
| 291 | ], |
| 292 | "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. |
| 293 | "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. |
| 294 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 295 | "endTime": "A String", # End of time span. |
| 296 | "startTime": "A String", # Start of time span. |
| 297 | }, |
| 298 | "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. |
| 299 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 300 | "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. |
| 301 | "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. |
| 302 | }, |
| 303 | ], |
| 304 | "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. |
| 305 | "A String", |
| 306 | ], |
| 307 | }, |
| 308 | ], |
| 309 | "substitutions": { # Substitutions data for `Build` resource. |
| 310 | "a_key": "A String", |
| 311 | }, |
| 312 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| 313 | "A String", |
| 314 | ], |
| 315 | "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 ten minutes. |
| 316 | "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 specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 317 | "a_key": { # Start and end times for a build execution phase. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 318 | "endTime": "A String", # End of time span. |
| 319 | "startTime": "A String", # Start of time span. |
| 320 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 321 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 322 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 323 | "createTime": "A String", # Output only. Time when the trigger was created. |
| 324 | "description": "A String", # Human-readable description of this trigger. |
| 325 | "disabled": True or False, # If true, the trigger will never automatically execute a build. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 326 | "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 327 | "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 328 | "installationId": "A String", # The installationID that emits the GitHub event. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 329 | "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 330 | "owner": "A String", # Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform". |
| 331 | "pullRequest": { # PullRequestFilter contains filter properties for matching GitHub Pull Requests. # filter to match changes in pull requests. |
| 332 | "branch": "A String", # Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 333 | "commentControl": "A String", # Configure builds to run whether a repository owner or collaborator need to comment `/gcbrun`. |
| 334 | "invertRegex": True or False, # If true, branches that do NOT match the git_ref will trigger a build. |
| 335 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 336 | "push": { # Push contains filter properties for matching GitHub git pushes. # filter to match changes in refs like branches, tags. |
| 337 | "branch": "A String", # Regexes 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 |
| 338 | "invertRegex": True or False, # When true, only trigger a build if the revision regex does NOT match the git_ref regex. |
| 339 | "tag": "A String", # Regexes 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 |
| 340 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 341 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 342 | "id": "A String", # Output only. Unique identifier of the trigger. |
| 343 | "ignoredFiles": [ # ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. |
| 344 | "A String", |
| 345 | ], |
| 346 | "includedFiles": [ # If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. |
| 347 | "A String", |
| 348 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 349 | "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 350 | "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. |
| 351 | "a_key": "A String", |
| 352 | }, |
| 353 | "tags": [ # Tags for annotation of a `BuildTrigger` |
| 354 | "A String", |
| 355 | ], |
| 356 | "triggerTemplate": { # Location of the source in a Google Cloud Source Repository. # Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`. |
| 357 | "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 |
| 358 | "commitSha": "A String", # Explicit commit SHA to build. |
| 359 | "dir": "A String", # 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. |
| 360 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 361 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 362 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 363 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 364 | "a_key": "A String", |
| 365 | }, |
| 366 | "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 |
| 367 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 368 | } |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 369 | |
| 370 | x__xgafv: string, V1 error format. |
| 371 | Allowed values |
| 372 | 1 - v1 error format |
| 373 | 2 - v2 error format |
| 374 | |
| 375 | Returns: |
| 376 | An object of the form: |
| 377 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 378 | { # Configuration for an automated build in response to source repository changes. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 379 | "build": { # 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. # Contents of the build template. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 380 | "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. |
| 381 | "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. |
| 382 | "A String", |
| 383 | ], |
| 384 | "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. |
| 385 | "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. |
| 386 | "paths": [ # Path globs used to match files in the build's workspace. |
| 387 | "A String", |
| 388 | ], |
| 389 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 390 | "endTime": "A String", # End of time span. |
| 391 | "startTime": "A String", # Start of time span. |
| 392 | }, |
| 393 | }, |
| 394 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 395 | "availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables. |
| 396 | "inline": [ # Secrets encrypted with KMS key and the associated secret environment variable. |
| 397 | { # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. |
| 398 | "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. |
| 399 | "a_key": "A String", |
| 400 | }, |
| 401 | "kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* |
| 402 | }, |
| 403 | ], |
| 404 | "secretManager": [ # Secrets in Secret Manager and associated secret environment variable. |
| 405 | { # Pairs a secret environment variable with a SecretVersion in Secret Manager. |
| 406 | "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. |
| 407 | "versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/* |
| 408 | }, |
| 409 | ], |
| 410 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 411 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| 412 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| 413 | "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. |
| 414 | "id": "A String", # Output only. Unique identifier of the build. |
| 415 | "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`. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 416 | "A String", |
| 417 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 418 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 419 | "logsBucket": "A String", # Google 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`. |
| 420 | "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. |
| 421 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 422 | "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 1000GB; builds that request more than the maximum are rejected with an error. |
| 423 | "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. |
| 424 | "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". |
| 425 | "A String", |
| 426 | ], |
| 427 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| 428 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| 429 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 430 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 431 | "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. |
| 432 | "A String", |
| 433 | ], |
| 434 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 435 | "A String", |
| 436 | ], |
| 437 | "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. |
| 438 | "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. |
| 439 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 440 | "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. |
| 441 | "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. |
| 442 | }, |
| 443 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 444 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 445 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 446 | "projectId": "A String", # Output only. ID of the project. |
| 447 | "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. |
| 448 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 449 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 450 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 451 | "endTime": "A String", # End of time span. |
| 452 | "startTime": "A String", # Start of time span. |
| 453 | }, |
| 454 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 455 | "A String", |
| 456 | ], |
| 457 | "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 4KB of data is stored. |
| 458 | "A String", |
| 459 | ], |
| 460 | "images": [ # Container images that were built as a part of the build. |
| 461 | { # An image built by the pipeline. |
| 462 | "digest": "A String", # Docker Registry 2.0 digest. |
| 463 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 464 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 465 | "endTime": "A String", # End of time span. |
| 466 | "startTime": "A String", # Start of time span. |
| 467 | }, |
| 468 | }, |
| 469 | ], |
| 470 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 471 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 472 | "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 |
| 473 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 474 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 475 | "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. |
| 476 | "a_key": "A String", |
| 477 | }, |
| 478 | }, |
| 479 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 480 | "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. This field is in beta. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 481 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| 482 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 483 | "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 |
| 484 | "commitSha": "A String", # Explicit commit SHA to build. |
| 485 | "dir": "A String", # 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. |
| 486 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 487 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 488 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 489 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 490 | "a_key": "A String", |
| 491 | }, |
| 492 | "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 |
| 493 | }, |
| 494 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 495 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 496 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 497 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 498 | }, |
| 499 | }, |
| 500 | "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. |
| 501 | "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. |
| 502 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 503 | "fileHash": [ # Collection of file hashes. |
| 504 | { # Container message for hash values. |
| 505 | "type": "A String", # The type of hash that was performed. |
| 506 | "value": "A String", # The hash value. |
| 507 | }, |
| 508 | ], |
| 509 | }, |
| 510 | }, |
| 511 | "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. |
| 512 | "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 |
| 513 | "commitSha": "A String", # Explicit commit SHA to build. |
| 514 | "dir": "A String", # 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. |
| 515 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 516 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 517 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 518 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 519 | "a_key": "A String", |
| 520 | }, |
| 521 | "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 |
| 522 | }, |
| 523 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 524 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 525 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 526 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 527 | }, |
| 528 | }, |
| 529 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 530 | "status": "A String", # Output only. Status of the build. |
| 531 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 532 | "steps": [ # Required. The operations to be performed on the workspace. |
| 533 | { # A step in the build pipeline. |
| 534 | "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. |
| 535 | "A String", |
| 536 | ], |
| 537 | "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. |
| 538 | "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. |
| 539 | "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". |
| 540 | "A String", |
| 541 | ], |
| 542 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 543 | "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. |
| 544 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 545 | "endTime": "A String", # End of time span. |
| 546 | "startTime": "A String", # Start of time span. |
| 547 | }, |
| 548 | "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`. |
| 549 | "A String", |
| 550 | ], |
| 551 | "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. |
| 552 | "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. |
| 553 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 554 | "endTime": "A String", # End of time span. |
| 555 | "startTime": "A String", # Start of time span. |
| 556 | }, |
| 557 | "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. |
| 558 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 559 | "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. |
| 560 | "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. |
| 561 | }, |
| 562 | ], |
| 563 | "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. |
| 564 | "A String", |
| 565 | ], |
| 566 | }, |
| 567 | ], |
| 568 | "substitutions": { # Substitutions data for `Build` resource. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 569 | "a_key": "A String", |
| 570 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 571 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 572 | "A String", |
| 573 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 574 | "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 ten minutes. |
| 575 | "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 specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 576 | "a_key": { # Start and end times for a build execution phase. |
| 577 | "endTime": "A String", # End of time span. |
| 578 | "startTime": "A String", # Start of time span. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 579 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 580 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 581 | }, |
| 582 | "createTime": "A String", # Output only. Time when the trigger was created. |
| 583 | "description": "A String", # Human-readable description of this trigger. |
| 584 | "disabled": True or False, # If true, the trigger will never automatically execute a build. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 585 | "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 586 | "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. |
| 587 | "installationId": "A String", # The installationID that emits the GitHub event. |
| 588 | "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". |
| 589 | "owner": "A String", # Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform". |
| 590 | "pullRequest": { # PullRequestFilter contains filter properties for matching GitHub Pull Requests. # filter to match changes in pull requests. |
| 591 | "branch": "A String", # Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 592 | "commentControl": "A String", # Configure builds to run whether a repository owner or collaborator need to comment `/gcbrun`. |
| 593 | "invertRegex": True or False, # If true, branches that do NOT match the git_ref will trigger a build. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 594 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 595 | "push": { # Push contains filter properties for matching GitHub git pushes. # filter to match changes in refs like branches, tags. |
| 596 | "branch": "A String", # Regexes 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 |
| 597 | "invertRegex": True or False, # When true, only trigger a build if the revision regex does NOT match the git_ref regex. |
| 598 | "tag": "A String", # Regexes 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 |
| 599 | }, |
| 600 | }, |
| 601 | "id": "A String", # Output only. Unique identifier of the trigger. |
| 602 | "ignoredFiles": [ # ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. |
| 603 | "A String", |
| 604 | ], |
| 605 | "includedFiles": [ # If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. |
| 606 | "A String", |
| 607 | ], |
| 608 | "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. |
| 609 | "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. |
| 610 | "a_key": "A String", |
| 611 | }, |
| 612 | "tags": [ # Tags for annotation of a `BuildTrigger` |
| 613 | "A String", |
| 614 | ], |
| 615 | "triggerTemplate": { # Location of the source in a Google Cloud Source Repository. # Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`. |
| 616 | "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 |
| 617 | "commitSha": "A String", # Explicit commit SHA to build. |
| 618 | "dir": "A String", # 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. |
| 619 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 620 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 621 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 622 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 623 | "a_key": "A String", |
| 624 | }, |
| 625 | "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 |
| 626 | }, |
| 627 | }</pre> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 628 | </div> |
| 629 | |
| 630 | <div class="method"> |
| 631 | <code class="details" id="delete">delete(projectId, triggerId, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 632 | <pre>Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 633 | |
| 634 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 635 | projectId: string, Required. ID of the project that owns the trigger. (required) |
| 636 | triggerId: string, Required. ID of the `BuildTrigger` to delete. (required) |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 637 | x__xgafv: string, V1 error format. |
| 638 | Allowed values |
| 639 | 1 - v1 error format |
| 640 | 2 - v2 error format |
| 641 | |
| 642 | Returns: |
| 643 | An object of the form: |
| 644 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 645 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 646 | }</pre> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 647 | </div> |
| 648 | |
| 649 | <div class="method"> |
| 650 | <code class="details" id="get">get(projectId, triggerId, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 651 | <pre>Returns information about a `BuildTrigger`. This API is experimental. |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 652 | |
| 653 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 654 | projectId: string, Required. ID of the project that owns the trigger. (required) |
| 655 | triggerId: string, Required. Identifier (`id` or `name`) of the `BuildTrigger` to get. (required) |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 656 | x__xgafv: string, V1 error format. |
| 657 | Allowed values |
| 658 | 1 - v1 error format |
| 659 | 2 - v2 error format |
| 660 | |
| 661 | Returns: |
| 662 | An object of the form: |
| 663 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 664 | { # Configuration for an automated build in response to source repository changes. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 665 | "build": { # 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. # Contents of the build template. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 666 | "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. |
| 667 | "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. |
| 668 | "A String", |
| 669 | ], |
| 670 | "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. |
| 671 | "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. |
| 672 | "paths": [ # Path globs used to match files in the build's workspace. |
| 673 | "A String", |
| 674 | ], |
| 675 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 676 | "endTime": "A String", # End of time span. |
| 677 | "startTime": "A String", # Start of time span. |
| 678 | }, |
| 679 | }, |
| 680 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 681 | "availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables. |
| 682 | "inline": [ # Secrets encrypted with KMS key and the associated secret environment variable. |
| 683 | { # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. |
| 684 | "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. |
| 685 | "a_key": "A String", |
| 686 | }, |
| 687 | "kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* |
| 688 | }, |
| 689 | ], |
| 690 | "secretManager": [ # Secrets in Secret Manager and associated secret environment variable. |
| 691 | { # Pairs a secret environment variable with a SecretVersion in Secret Manager. |
| 692 | "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. |
| 693 | "versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/* |
| 694 | }, |
| 695 | ], |
| 696 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 697 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| 698 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| 699 | "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. |
| 700 | "id": "A String", # Output only. Unique identifier of the build. |
| 701 | "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`. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 702 | "A String", |
| 703 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 704 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 705 | "logsBucket": "A String", # Google 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`. |
| 706 | "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. |
| 707 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 708 | "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 1000GB; builds that request more than the maximum are rejected with an error. |
| 709 | "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. |
| 710 | "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". |
| 711 | "A String", |
| 712 | ], |
| 713 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| 714 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| 715 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 716 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 717 | "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. |
| 718 | "A String", |
| 719 | ], |
| 720 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 721 | "A String", |
| 722 | ], |
| 723 | "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. |
| 724 | "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. |
| 725 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 726 | "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. |
| 727 | "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. |
| 728 | }, |
| 729 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 730 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 731 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 732 | "projectId": "A String", # Output only. ID of the project. |
| 733 | "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. |
| 734 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 735 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 736 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 737 | "endTime": "A String", # End of time span. |
| 738 | "startTime": "A String", # Start of time span. |
| 739 | }, |
| 740 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 741 | "A String", |
| 742 | ], |
| 743 | "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 4KB of data is stored. |
| 744 | "A String", |
| 745 | ], |
| 746 | "images": [ # Container images that were built as a part of the build. |
| 747 | { # An image built by the pipeline. |
| 748 | "digest": "A String", # Docker Registry 2.0 digest. |
| 749 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 750 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 751 | "endTime": "A String", # End of time span. |
| 752 | "startTime": "A String", # Start of time span. |
| 753 | }, |
| 754 | }, |
| 755 | ], |
| 756 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 757 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 758 | "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 |
| 759 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 760 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 761 | "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. |
| 762 | "a_key": "A String", |
| 763 | }, |
| 764 | }, |
| 765 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 766 | "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. This field is in beta. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 767 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| 768 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 769 | "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 |
| 770 | "commitSha": "A String", # Explicit commit SHA to build. |
| 771 | "dir": "A String", # 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. |
| 772 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 773 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 774 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 775 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 776 | "a_key": "A String", |
| 777 | }, |
| 778 | "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 |
| 779 | }, |
| 780 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 781 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 782 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 783 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 784 | }, |
| 785 | }, |
| 786 | "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. |
| 787 | "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. |
| 788 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 789 | "fileHash": [ # Collection of file hashes. |
| 790 | { # Container message for hash values. |
| 791 | "type": "A String", # The type of hash that was performed. |
| 792 | "value": "A String", # The hash value. |
| 793 | }, |
| 794 | ], |
| 795 | }, |
| 796 | }, |
| 797 | "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. |
| 798 | "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 |
| 799 | "commitSha": "A String", # Explicit commit SHA to build. |
| 800 | "dir": "A String", # 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. |
| 801 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 802 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 803 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 804 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 805 | "a_key": "A String", |
| 806 | }, |
| 807 | "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 |
| 808 | }, |
| 809 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 810 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 811 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 812 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 813 | }, |
| 814 | }, |
| 815 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 816 | "status": "A String", # Output only. Status of the build. |
| 817 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 818 | "steps": [ # Required. The operations to be performed on the workspace. |
| 819 | { # A step in the build pipeline. |
| 820 | "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. |
| 821 | "A String", |
| 822 | ], |
| 823 | "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. |
| 824 | "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. |
| 825 | "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". |
| 826 | "A String", |
| 827 | ], |
| 828 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 829 | "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. |
| 830 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 831 | "endTime": "A String", # End of time span. |
| 832 | "startTime": "A String", # Start of time span. |
| 833 | }, |
| 834 | "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`. |
| 835 | "A String", |
| 836 | ], |
| 837 | "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. |
| 838 | "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. |
| 839 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 840 | "endTime": "A String", # End of time span. |
| 841 | "startTime": "A String", # Start of time span. |
| 842 | }, |
| 843 | "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. |
| 844 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 845 | "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. |
| 846 | "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. |
| 847 | }, |
| 848 | ], |
| 849 | "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. |
| 850 | "A String", |
| 851 | ], |
| 852 | }, |
| 853 | ], |
| 854 | "substitutions": { # Substitutions data for `Build` resource. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 855 | "a_key": "A String", |
| 856 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 857 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 858 | "A String", |
| 859 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 860 | "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 ten minutes. |
| 861 | "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 specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 862 | "a_key": { # Start and end times for a build execution phase. |
| 863 | "endTime": "A String", # End of time span. |
| 864 | "startTime": "A String", # Start of time span. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 865 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 866 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 867 | }, |
| 868 | "createTime": "A String", # Output only. Time when the trigger was created. |
| 869 | "description": "A String", # Human-readable description of this trigger. |
| 870 | "disabled": True or False, # If true, the trigger will never automatically execute a build. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 871 | "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 872 | "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. |
| 873 | "installationId": "A String", # The installationID that emits the GitHub event. |
| 874 | "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". |
| 875 | "owner": "A String", # Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform". |
| 876 | "pullRequest": { # PullRequestFilter contains filter properties for matching GitHub Pull Requests. # filter to match changes in pull requests. |
| 877 | "branch": "A String", # Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 878 | "commentControl": "A String", # Configure builds to run whether a repository owner or collaborator need to comment `/gcbrun`. |
| 879 | "invertRegex": True or False, # If true, branches that do NOT match the git_ref will trigger a build. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 880 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 881 | "push": { # Push contains filter properties for matching GitHub git pushes. # filter to match changes in refs like branches, tags. |
| 882 | "branch": "A String", # Regexes 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 |
| 883 | "invertRegex": True or False, # When true, only trigger a build if the revision regex does NOT match the git_ref regex. |
| 884 | "tag": "A String", # Regexes 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 |
| 885 | }, |
| 886 | }, |
| 887 | "id": "A String", # Output only. Unique identifier of the trigger. |
| 888 | "ignoredFiles": [ # ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. |
| 889 | "A String", |
| 890 | ], |
| 891 | "includedFiles": [ # If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. |
| 892 | "A String", |
| 893 | ], |
| 894 | "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. |
| 895 | "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. |
| 896 | "a_key": "A String", |
| 897 | }, |
| 898 | "tags": [ # Tags for annotation of a `BuildTrigger` |
| 899 | "A String", |
| 900 | ], |
| 901 | "triggerTemplate": { # Location of the source in a Google Cloud Source Repository. # Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`. |
| 902 | "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 |
| 903 | "commitSha": "A String", # Explicit commit SHA to build. |
| 904 | "dir": "A String", # 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. |
| 905 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 906 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 907 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 908 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 909 | "a_key": "A String", |
| 910 | }, |
| 911 | "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 |
| 912 | }, |
| 913 | }</pre> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 914 | </div> |
| 915 | |
| 916 | <div class="method"> |
| 917 | <code class="details" id="list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 918 | <pre>Lists existing `BuildTrigger`s. This API is experimental. |
| 919 | |
| 920 | Args: |
| 921 | projectId: string, Required. ID of the project for which to list BuildTriggers. (required) |
| 922 | pageSize: integer, Number of results to return in the list. |
| 923 | pageToken: string, Token to provide to skip to a particular spot in the list. |
| 924 | x__xgafv: string, V1 error format. |
| 925 | Allowed values |
| 926 | 1 - v1 error format |
| 927 | 2 - v2 error format |
| 928 | |
| 929 | Returns: |
| 930 | An object of the form: |
| 931 | |
| 932 | { # Response containing existing `BuildTriggers`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 933 | "nextPageToken": "A String", # Token to receive the next page of results. |
| 934 | "triggers": [ # `BuildTriggers` for the project, sorted by `create_time` descending. |
| 935 | { # Configuration for an automated build in response to source repository changes. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 936 | "build": { # 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. # Contents of the build template. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 937 | "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. |
| 938 | "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. |
| 939 | "A String", |
| 940 | ], |
| 941 | "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. |
| 942 | "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. |
| 943 | "paths": [ # Path globs used to match files in the build's workspace. |
| 944 | "A String", |
| 945 | ], |
| 946 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 947 | "endTime": "A String", # End of time span. |
| 948 | "startTime": "A String", # Start of time span. |
| 949 | }, |
| 950 | }, |
| 951 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 952 | "availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables. |
| 953 | "inline": [ # Secrets encrypted with KMS key and the associated secret environment variable. |
| 954 | { # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. |
| 955 | "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. |
| 956 | "a_key": "A String", |
| 957 | }, |
| 958 | "kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* |
| 959 | }, |
| 960 | ], |
| 961 | "secretManager": [ # Secrets in Secret Manager and associated secret environment variable. |
| 962 | { # Pairs a secret environment variable with a SecretVersion in Secret Manager. |
| 963 | "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. |
| 964 | "versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/* |
| 965 | }, |
| 966 | ], |
| 967 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 968 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| 969 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| 970 | "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. |
| 971 | "id": "A String", # Output only. Unique identifier of the build. |
| 972 | "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`. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 973 | "A String", |
| 974 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 975 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 976 | "logsBucket": "A String", # Google 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`. |
| 977 | "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. |
| 978 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 979 | "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 1000GB; builds that request more than the maximum are rejected with an error. |
| 980 | "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. |
| 981 | "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". |
| 982 | "A String", |
| 983 | ], |
| 984 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| 985 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| 986 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 987 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 988 | "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. |
| 989 | "A String", |
| 990 | ], |
| 991 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 992 | "A String", |
| 993 | ], |
| 994 | "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. |
| 995 | "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. |
| 996 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 997 | "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. |
| 998 | "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. |
| 999 | }, |
| 1000 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1001 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1002 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1003 | "projectId": "A String", # Output only. ID of the project. |
| 1004 | "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. |
| 1005 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 1006 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 1007 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 1008 | "endTime": "A String", # End of time span. |
| 1009 | "startTime": "A String", # Start of time span. |
| 1010 | }, |
| 1011 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 1012 | "A String", |
| 1013 | ], |
| 1014 | "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 4KB of data is stored. |
| 1015 | "A String", |
| 1016 | ], |
| 1017 | "images": [ # Container images that were built as a part of the build. |
| 1018 | { # An image built by the pipeline. |
| 1019 | "digest": "A String", # Docker Registry 2.0 digest. |
| 1020 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 1021 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 1022 | "endTime": "A String", # End of time span. |
| 1023 | "startTime": "A String", # Start of time span. |
| 1024 | }, |
| 1025 | }, |
| 1026 | ], |
| 1027 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 1028 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1029 | "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 |
| 1030 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1031 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 1032 | "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. |
| 1033 | "a_key": "A String", |
| 1034 | }, |
| 1035 | }, |
| 1036 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1037 | "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. This field is in beta. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1038 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| 1039 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 1040 | "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 |
| 1041 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1042 | "dir": "A String", # 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. |
| 1043 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 1044 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1045 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1046 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1047 | "a_key": "A String", |
| 1048 | }, |
| 1049 | "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 |
| 1050 | }, |
| 1051 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 1052 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1053 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 1054 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 1055 | }, |
| 1056 | }, |
| 1057 | "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. |
| 1058 | "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. |
| 1059 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 1060 | "fileHash": [ # Collection of file hashes. |
| 1061 | { # Container message for hash values. |
| 1062 | "type": "A String", # The type of hash that was performed. |
| 1063 | "value": "A String", # The hash value. |
| 1064 | }, |
| 1065 | ], |
| 1066 | }, |
| 1067 | }, |
| 1068 | "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. |
| 1069 | "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 |
| 1070 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1071 | "dir": "A String", # 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. |
| 1072 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 1073 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1074 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1075 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1076 | "a_key": "A String", |
| 1077 | }, |
| 1078 | "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 |
| 1079 | }, |
| 1080 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 1081 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1082 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 1083 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 1084 | }, |
| 1085 | }, |
| 1086 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 1087 | "status": "A String", # Output only. Status of the build. |
| 1088 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 1089 | "steps": [ # Required. The operations to be performed on the workspace. |
| 1090 | { # A step in the build pipeline. |
| 1091 | "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. |
| 1092 | "A String", |
| 1093 | ], |
| 1094 | "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. |
| 1095 | "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. |
| 1096 | "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". |
| 1097 | "A String", |
| 1098 | ], |
| 1099 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 1100 | "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. |
| 1101 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 1102 | "endTime": "A String", # End of time span. |
| 1103 | "startTime": "A String", # Start of time span. |
| 1104 | }, |
| 1105 | "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`. |
| 1106 | "A String", |
| 1107 | ], |
| 1108 | "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. |
| 1109 | "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. |
| 1110 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 1111 | "endTime": "A String", # End of time span. |
| 1112 | "startTime": "A String", # Start of time span. |
| 1113 | }, |
| 1114 | "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. |
| 1115 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 1116 | "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. |
| 1117 | "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. |
| 1118 | }, |
| 1119 | ], |
| 1120 | "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. |
| 1121 | "A String", |
| 1122 | ], |
| 1123 | }, |
| 1124 | ], |
| 1125 | "substitutions": { # Substitutions data for `Build` resource. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1126 | "a_key": "A String", |
| 1127 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1128 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1129 | "A String", |
| 1130 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1131 | "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 ten minutes. |
| 1132 | "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 specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 1133 | "a_key": { # Start and end times for a build execution phase. |
| 1134 | "endTime": "A String", # End of time span. |
| 1135 | "startTime": "A String", # Start of time span. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1136 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1137 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1138 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1139 | "createTime": "A String", # Output only. Time when the trigger was created. |
| 1140 | "description": "A String", # Human-readable description of this trigger. |
| 1141 | "disabled": True or False, # If true, the trigger will never automatically execute a build. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1142 | "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1143 | "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. |
| 1144 | "installationId": "A String", # The installationID that emits the GitHub event. |
| 1145 | "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". |
| 1146 | "owner": "A String", # Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform". |
| 1147 | "pullRequest": { # PullRequestFilter contains filter properties for matching GitHub Pull Requests. # filter to match changes in pull requests. |
| 1148 | "branch": "A String", # Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 1149 | "commentControl": "A String", # Configure builds to run whether a repository owner or collaborator need to comment `/gcbrun`. |
| 1150 | "invertRegex": True or False, # If true, branches that do NOT match the git_ref will trigger a build. |
| 1151 | }, |
| 1152 | "push": { # Push contains filter properties for matching GitHub git pushes. # filter to match changes in refs like branches, tags. |
| 1153 | "branch": "A String", # Regexes 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 |
| 1154 | "invertRegex": True or False, # When true, only trigger a build if the revision regex does NOT match the git_ref regex. |
| 1155 | "tag": "A String", # Regexes 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 |
| 1156 | }, |
| 1157 | }, |
| 1158 | "id": "A String", # Output only. Unique identifier of the trigger. |
| 1159 | "ignoredFiles": [ # ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. |
| 1160 | "A String", |
| 1161 | ], |
| 1162 | "includedFiles": [ # If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. |
| 1163 | "A String", |
| 1164 | ], |
| 1165 | "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. |
| 1166 | "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. |
| 1167 | "a_key": "A String", |
| 1168 | }, |
| 1169 | "tags": [ # Tags for annotation of a `BuildTrigger` |
| 1170 | "A String", |
| 1171 | ], |
| 1172 | "triggerTemplate": { # Location of the source in a Google Cloud Source Repository. # Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`. |
| 1173 | "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 |
| 1174 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1175 | "dir": "A String", # 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. |
| 1176 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 1177 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1178 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1179 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1180 | "a_key": "A String", |
| 1181 | }, |
| 1182 | "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 |
| 1183 | }, |
| 1184 | }, |
| 1185 | ], |
| 1186 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1187 | </div> |
| 1188 | |
| 1189 | <div class="method"> |
| 1190 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1191 | <pre>Retrieves the next page of results. |
| 1192 | |
| 1193 | Args: |
| 1194 | previous_request: The request for the previous page. (required) |
| 1195 | previous_response: The response from the request for the previous page. (required) |
| 1196 | |
| 1197 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1198 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1199 | page. Returns None if there are no more items in the collection. |
| 1200 | </pre> |
| 1201 | </div> |
| 1202 | |
| 1203 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1204 | <code class="details" id="patch">patch(projectId, triggerId, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1205 | <pre>Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1206 | |
| 1207 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1208 | projectId: string, Required. ID of the project that owns the trigger. (required) |
| 1209 | triggerId: string, Required. ID of the `BuildTrigger` to update. (required) |
| 1210 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1211 | The object takes the form of: |
| 1212 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1213 | { # Configuration for an automated build in response to source repository changes. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1214 | "build": { # 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. # Contents of the build template. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1215 | "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. |
| 1216 | "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. |
| 1217 | "A String", |
| 1218 | ], |
| 1219 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1220 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1221 | "paths": [ # Path globs used to match files in the build's workspace. |
| 1222 | "A String", |
| 1223 | ], |
| 1224 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 1225 | "endTime": "A String", # End of time span. |
| 1226 | "startTime": "A String", # Start of time span. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1227 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1228 | }, |
| 1229 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1230 | "availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables. |
| 1231 | "inline": [ # Secrets encrypted with KMS key and the associated secret environment variable. |
| 1232 | { # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. |
| 1233 | "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. |
| 1234 | "a_key": "A String", |
| 1235 | }, |
| 1236 | "kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* |
| 1237 | }, |
| 1238 | ], |
| 1239 | "secretManager": [ # Secrets in Secret Manager and associated secret environment variable. |
| 1240 | { # Pairs a secret environment variable with a SecretVersion in Secret Manager. |
| 1241 | "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. |
| 1242 | "versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/* |
| 1243 | }, |
| 1244 | ], |
| 1245 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1246 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1247 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1248 | "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. |
| 1249 | "id": "A String", # Output only. Unique identifier of the build. |
| 1250 | "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`. |
| 1251 | "A String", |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1252 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1253 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 1254 | "logsBucket": "A String", # Google 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`. |
| 1255 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1256 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1257 | "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 1000GB; builds that request more than the maximum are rejected with an error. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1258 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1259 | "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". |
| 1260 | "A String", |
| 1261 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1262 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| 1263 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| 1264 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 1265 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 1266 | "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. |
| 1267 | "A String", |
| 1268 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1269 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 1270 | "A String", |
| 1271 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1272 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1273 | "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. |
| 1274 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1275 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1276 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1277 | }, |
| 1278 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1279 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1280 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1281 | "projectId": "A String", # Output only. ID of the project. |
| 1282 | "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. |
| 1283 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 1284 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 1285 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 1286 | "endTime": "A String", # End of time span. |
| 1287 | "startTime": "A String", # Start of time span. |
| 1288 | }, |
| 1289 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 1290 | "A String", |
| 1291 | ], |
| 1292 | "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 4KB of data is stored. |
| 1293 | "A String", |
| 1294 | ], |
| 1295 | "images": [ # Container images that were built as a part of the build. |
| 1296 | { # An image built by the pipeline. |
| 1297 | "digest": "A String", # Docker Registry 2.0 digest. |
| 1298 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 1299 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 1300 | "endTime": "A String", # End of time span. |
| 1301 | "startTime": "A String", # Start of time span. |
| 1302 | }, |
| 1303 | }, |
| 1304 | ], |
| 1305 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 1306 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1307 | "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 |
| 1308 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1309 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 1310 | "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. |
| 1311 | "a_key": "A String", |
| 1312 | }, |
| 1313 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1314 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1315 | "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. This field is in beta. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1316 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| 1317 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 1318 | "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 |
| 1319 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1320 | "dir": "A String", # 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. |
| 1321 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 1322 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1323 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1324 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1325 | "a_key": "A String", |
| 1326 | }, |
| 1327 | "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 |
| 1328 | }, |
| 1329 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 1330 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1331 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 1332 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1333 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1334 | }, |
| 1335 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1336 | "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. |
| 1337 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 1338 | "fileHash": [ # Collection of file hashes. |
| 1339 | { # Container message for hash values. |
| 1340 | "type": "A String", # The type of hash that was performed. |
| 1341 | "value": "A String", # The hash value. |
| 1342 | }, |
| 1343 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1344 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1345 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1346 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1347 | "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 |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1348 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1349 | "dir": "A String", # 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. |
| 1350 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1351 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1352 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1353 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1354 | "a_key": "A String", |
| 1355 | }, |
| 1356 | "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 |
| 1357 | }, |
| 1358 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 1359 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1360 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 1361 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1362 | }, |
| 1363 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1364 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 1365 | "status": "A String", # Output only. Status of the build. |
| 1366 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 1367 | "steps": [ # Required. The operations to be performed on the workspace. |
| 1368 | { # A step in the build pipeline. |
| 1369 | "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. |
| 1370 | "A String", |
| 1371 | ], |
| 1372 | "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. |
| 1373 | "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. |
| 1374 | "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". |
| 1375 | "A String", |
| 1376 | ], |
| 1377 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 1378 | "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. |
| 1379 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 1380 | "endTime": "A String", # End of time span. |
| 1381 | "startTime": "A String", # Start of time span. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1382 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1383 | "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`. |
| 1384 | "A String", |
| 1385 | ], |
| 1386 | "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. |
| 1387 | "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. |
| 1388 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 1389 | "endTime": "A String", # End of time span. |
| 1390 | "startTime": "A String", # Start of time span. |
| 1391 | }, |
| 1392 | "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. |
| 1393 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 1394 | "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. |
| 1395 | "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. |
| 1396 | }, |
| 1397 | ], |
| 1398 | "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. |
| 1399 | "A String", |
| 1400 | ], |
| 1401 | }, |
| 1402 | ], |
| 1403 | "substitutions": { # Substitutions data for `Build` resource. |
| 1404 | "a_key": "A String", |
| 1405 | }, |
| 1406 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| 1407 | "A String", |
| 1408 | ], |
| 1409 | "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 ten minutes. |
| 1410 | "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 specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 1411 | "a_key": { # Start and end times for a build execution phase. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1412 | "endTime": "A String", # End of time span. |
| 1413 | "startTime": "A String", # Start of time span. |
| 1414 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1415 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1416 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1417 | "createTime": "A String", # Output only. Time when the trigger was created. |
| 1418 | "description": "A String", # Human-readable description of this trigger. |
| 1419 | "disabled": True or False, # If true, the trigger will never automatically execute a build. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1420 | "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1421 | "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1422 | "installationId": "A String", # The installationID that emits the GitHub event. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1423 | "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1424 | "owner": "A String", # Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform". |
| 1425 | "pullRequest": { # PullRequestFilter contains filter properties for matching GitHub Pull Requests. # filter to match changes in pull requests. |
| 1426 | "branch": "A String", # Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 1427 | "commentControl": "A String", # Configure builds to run whether a repository owner or collaborator need to comment `/gcbrun`. |
| 1428 | "invertRegex": True or False, # If true, branches that do NOT match the git_ref will trigger a build. |
| 1429 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1430 | "push": { # Push contains filter properties for matching GitHub git pushes. # filter to match changes in refs like branches, tags. |
| 1431 | "branch": "A String", # Regexes 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 |
| 1432 | "invertRegex": True or False, # When true, only trigger a build if the revision regex does NOT match the git_ref regex. |
| 1433 | "tag": "A String", # Regexes 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 |
| 1434 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1435 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1436 | "id": "A String", # Output only. Unique identifier of the trigger. |
| 1437 | "ignoredFiles": [ # ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. |
| 1438 | "A String", |
| 1439 | ], |
| 1440 | "includedFiles": [ # If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. |
| 1441 | "A String", |
| 1442 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1443 | "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1444 | "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. |
| 1445 | "a_key": "A String", |
| 1446 | }, |
| 1447 | "tags": [ # Tags for annotation of a `BuildTrigger` |
| 1448 | "A String", |
| 1449 | ], |
| 1450 | "triggerTemplate": { # Location of the source in a Google Cloud Source Repository. # Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`. |
| 1451 | "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 |
| 1452 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1453 | "dir": "A String", # 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. |
| 1454 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 1455 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1456 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1457 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1458 | "a_key": "A String", |
| 1459 | }, |
| 1460 | "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 |
| 1461 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1462 | } |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1463 | |
| 1464 | x__xgafv: string, V1 error format. |
| 1465 | Allowed values |
| 1466 | 1 - v1 error format |
| 1467 | 2 - v2 error format |
| 1468 | |
| 1469 | Returns: |
| 1470 | An object of the form: |
| 1471 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1472 | { # Configuration for an automated build in response to source repository changes. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1473 | "build": { # 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. # Contents of the build template. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1474 | "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. |
| 1475 | "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. |
| 1476 | "A String", |
| 1477 | ], |
| 1478 | "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. |
| 1479 | "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. |
| 1480 | "paths": [ # Path globs used to match files in the build's workspace. |
| 1481 | "A String", |
| 1482 | ], |
| 1483 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 1484 | "endTime": "A String", # End of time span. |
| 1485 | "startTime": "A String", # Start of time span. |
| 1486 | }, |
| 1487 | }, |
| 1488 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1489 | "availableSecrets": { # Secrets and secret environment variables. # Secrets and secret environment variables. |
| 1490 | "inline": [ # Secrets encrypted with KMS key and the associated secret environment variable. |
| 1491 | { # Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. |
| 1492 | "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. |
| 1493 | "a_key": "A String", |
| 1494 | }, |
| 1495 | "kmsKeyName": "A String", # Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* |
| 1496 | }, |
| 1497 | ], |
| 1498 | "secretManager": [ # Secrets in Secret Manager and associated secret environment variable. |
| 1499 | { # Pairs a secret environment variable with a SecretVersion in Secret Manager. |
| 1500 | "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. |
| 1501 | "versionName": "A String", # Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/* |
| 1502 | }, |
| 1503 | ], |
| 1504 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1505 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| 1506 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| 1507 | "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. |
| 1508 | "id": "A String", # Output only. Unique identifier of the build. |
| 1509 | "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`. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1510 | "A String", |
| 1511 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1512 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 1513 | "logsBucket": "A String", # Google 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`. |
| 1514 | "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. |
| 1515 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 1516 | "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 1000GB; builds that request more than the maximum are rejected with an error. |
| 1517 | "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. |
| 1518 | "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". |
| 1519 | "A String", |
| 1520 | ], |
| 1521 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| 1522 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| 1523 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 1524 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 1525 | "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. |
| 1526 | "A String", |
| 1527 | ], |
| 1528 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 1529 | "A String", |
| 1530 | ], |
| 1531 | "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. |
| 1532 | "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. |
| 1533 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 1534 | "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. |
| 1535 | "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. |
| 1536 | }, |
| 1537 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1538 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1539 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1540 | "projectId": "A String", # Output only. ID of the project. |
| 1541 | "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. |
| 1542 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 1543 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 1544 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 1545 | "endTime": "A String", # End of time span. |
| 1546 | "startTime": "A String", # Start of time span. |
| 1547 | }, |
| 1548 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 1549 | "A String", |
| 1550 | ], |
| 1551 | "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 4KB of data is stored. |
| 1552 | "A String", |
| 1553 | ], |
| 1554 | "images": [ # Container images that were built as a part of the build. |
| 1555 | { # An image built by the pipeline. |
| 1556 | "digest": "A String", # Docker Registry 2.0 digest. |
| 1557 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 1558 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 1559 | "endTime": "A String", # End of time span. |
| 1560 | "startTime": "A String", # Start of time span. |
| 1561 | }, |
| 1562 | }, |
| 1563 | ], |
| 1564 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 1565 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1566 | "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 |
| 1567 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1568 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 1569 | "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. |
| 1570 | "a_key": "A String", |
| 1571 | }, |
| 1572 | }, |
| 1573 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1574 | "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. This field is in beta. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1575 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| 1576 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 1577 | "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 |
| 1578 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1579 | "dir": "A String", # 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. |
| 1580 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 1581 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1582 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1583 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1584 | "a_key": "A String", |
| 1585 | }, |
| 1586 | "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 |
| 1587 | }, |
| 1588 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 1589 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1590 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 1591 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 1592 | }, |
| 1593 | }, |
| 1594 | "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. |
| 1595 | "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. |
| 1596 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 1597 | "fileHash": [ # Collection of file hashes. |
| 1598 | { # Container message for hash values. |
| 1599 | "type": "A String", # The type of hash that was performed. |
| 1600 | "value": "A String", # The hash value. |
| 1601 | }, |
| 1602 | ], |
| 1603 | }, |
| 1604 | }, |
| 1605 | "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. |
| 1606 | "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 |
| 1607 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1608 | "dir": "A String", # 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. |
| 1609 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 1610 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1611 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1612 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1613 | "a_key": "A String", |
| 1614 | }, |
| 1615 | "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 |
| 1616 | }, |
| 1617 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 1618 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1619 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 1620 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 1621 | }, |
| 1622 | }, |
| 1623 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 1624 | "status": "A String", # Output only. Status of the build. |
| 1625 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 1626 | "steps": [ # Required. The operations to be performed on the workspace. |
| 1627 | { # A step in the build pipeline. |
| 1628 | "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. |
| 1629 | "A String", |
| 1630 | ], |
| 1631 | "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. |
| 1632 | "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. |
| 1633 | "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". |
| 1634 | "A String", |
| 1635 | ], |
| 1636 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 1637 | "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. |
| 1638 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 1639 | "endTime": "A String", # End of time span. |
| 1640 | "startTime": "A String", # Start of time span. |
| 1641 | }, |
| 1642 | "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`. |
| 1643 | "A String", |
| 1644 | ], |
| 1645 | "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. |
| 1646 | "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. |
| 1647 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 1648 | "endTime": "A String", # End of time span. |
| 1649 | "startTime": "A String", # Start of time span. |
| 1650 | }, |
| 1651 | "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. |
| 1652 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 1653 | "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. |
| 1654 | "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. |
| 1655 | }, |
| 1656 | ], |
| 1657 | "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. |
| 1658 | "A String", |
| 1659 | ], |
| 1660 | }, |
| 1661 | ], |
| 1662 | "substitutions": { # Substitutions data for `Build` resource. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1663 | "a_key": "A String", |
| 1664 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1665 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1666 | "A String", |
| 1667 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1668 | "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 ten minutes. |
| 1669 | "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 specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 1670 | "a_key": { # Start and end times for a build execution phase. |
| 1671 | "endTime": "A String", # End of time span. |
| 1672 | "startTime": "A String", # Start of time span. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1673 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1674 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1675 | }, |
| 1676 | "createTime": "A String", # Output only. Time when the trigger was created. |
| 1677 | "description": "A String", # Human-readable description of this trigger. |
| 1678 | "disabled": True or False, # If true, the trigger will never automatically execute a build. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1679 | "filename": "A String", # Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1680 | "github": { # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental. # GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. |
| 1681 | "installationId": "A String", # The installationID that emits the GitHub event. |
| 1682 | "name": "A String", # Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders". |
| 1683 | "owner": "A String", # Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform". |
| 1684 | "pullRequest": { # PullRequestFilter contains filter properties for matching GitHub Pull Requests. # filter to match changes in pull requests. |
| 1685 | "branch": "A String", # Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 1686 | "commentControl": "A String", # Configure builds to run whether a repository owner or collaborator need to comment `/gcbrun`. |
| 1687 | "invertRegex": True or False, # If true, branches that do NOT match the git_ref will trigger a build. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1688 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1689 | "push": { # Push contains filter properties for matching GitHub git pushes. # filter to match changes in refs like branches, tags. |
| 1690 | "branch": "A String", # Regexes 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 |
| 1691 | "invertRegex": True or False, # When true, only trigger a build if the revision regex does NOT match the git_ref regex. |
| 1692 | "tag": "A String", # Regexes 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 |
| 1693 | }, |
| 1694 | }, |
| 1695 | "id": "A String", # Output only. Unique identifier of the trigger. |
| 1696 | "ignoredFiles": [ # ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. |
| 1697 | "A String", |
| 1698 | ], |
| 1699 | "includedFiles": [ # If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. |
| 1700 | "A String", |
| 1701 | ], |
| 1702 | "name": "A String", # User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. |
| 1703 | "substitutions": { # Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. |
| 1704 | "a_key": "A String", |
| 1705 | }, |
| 1706 | "tags": [ # Tags for annotation of a `BuildTrigger` |
| 1707 | "A String", |
| 1708 | ], |
| 1709 | "triggerTemplate": { # Location of the source in a Google Cloud Source Repository. # Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`. |
| 1710 | "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 |
| 1711 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1712 | "dir": "A String", # 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. |
| 1713 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 1714 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1715 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1716 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1717 | "a_key": "A String", |
| 1718 | }, |
| 1719 | "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 |
| 1720 | }, |
| 1721 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1722 | </div> |
| 1723 | |
| 1724 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1725 | <code class="details" id="run">run(projectId, triggerId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1726 | <pre>Runs a `BuildTrigger` at a particular source revision. |
| 1727 | |
| 1728 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1729 | projectId: string, Required. ID of the project. (required) |
| 1730 | triggerId: string, Required. ID of the trigger. (required) |
| 1731 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1732 | The object takes the form of: |
| 1733 | |
| 1734 | { # Location of the source in a Google Cloud Source Repository. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1735 | "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 |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1736 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1737 | "dir": "A String", # 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. |
| 1738 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1739 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1740 | "repoName": "A String", # Name of the Cloud Source Repository. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1741 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 1742 | "a_key": "A String", |
| 1743 | }, |
| 1744 | "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 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1745 | } |
| 1746 | |
| 1747 | x__xgafv: string, V1 error format. |
| 1748 | Allowed values |
| 1749 | 1 - v1 error format |
| 1750 | 2 - v2 error format |
| 1751 | |
| 1752 | Returns: |
| 1753 | An object of the form: |
| 1754 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1755 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1756 | "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. |
| 1757 | "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. |
| 1758 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1759 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1760 | { |
| 1761 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1762 | }, |
| 1763 | ], |
| 1764 | "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. |
| 1765 | }, |
| 1766 | "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. |
| 1767 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1768 | }, |
| 1769 | "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}`. |
| 1770 | "response": { # The normal response of the operation in case of success. 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`. |
| 1771 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1772 | }, |
| 1773 | }</pre> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1774 | </div> |
| 1775 | |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame^] | 1776 | <div class="method"> |
| 1777 | <code class="details" id="webhook">webhook(projectId, trigger, body=None, secret=None, x__xgafv=None)</code> |
| 1778 | <pre>ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger. |
| 1779 | |
| 1780 | Args: |
| 1781 | projectId: string, Project in which the specified trigger lives (required) |
| 1782 | trigger: string, Name of the trigger to run the payload against (required) |
| 1783 | body: object, The request body. |
| 1784 | The object takes the form of: |
| 1785 | |
| 1786 | { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. |
| 1787 | "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| 1788 | "data": "A String", # The HTTP request/response body as raw binary. |
| 1789 | "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. |
| 1790 | { |
| 1791 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1792 | }, |
| 1793 | ], |
| 1794 | } |
| 1795 | |
| 1796 | secret: string, Secret token used for authorization if an OAuth token isn't provided. |
| 1797 | x__xgafv: string, V1 error format. |
| 1798 | Allowed values |
| 1799 | 1 - v1 error format |
| 1800 | 2 - v2 error format |
| 1801 | |
| 1802 | Returns: |
| 1803 | An object of the form: |
| 1804 | |
| 1805 | { # ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method. |
| 1806 | }</pre> |
| 1807 | </div> |
| 1808 | |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1809 | </body></html> |