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 | |
| 75 | <h1><a href="cloudbuild_v1.html">Google Cloud Container Builder API</a> . <a href="cloudbuild_v1.projects.html">projects</a> . <a href="cloudbuild_v1.projects.triggers.html">triggers</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(projectId, body, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a new BuildTrigger.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(projectId, triggerId, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes an BuildTrigger by its project ID and trigger ID.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(projectId, triggerId, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets information about a BuildTrigger.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(projectId, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Lists existing BuildTrigger.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#patch">patch(projectId, triggerId, body, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Updates an BuildTrigger by its project ID and trigger ID.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="create">create(projectId, body, x__xgafv=None)</code> |
| 95 | <pre>Creates a new BuildTrigger. |
| 96 | |
| 97 | This API is experimental. |
| 98 | |
| 99 | Args: |
| 100 | projectId: string, ID of the project for which to configure automatic builds. (required) |
| 101 | body: object, The request body. (required) |
| 102 | The object takes the form of: |
| 103 | |
| 104 | { # Configuration for an automated build in response to source repository |
| 105 | # changes. |
| 106 | "id": "A String", # Unique identifier of the trigger. |
| 107 | # |
| 108 | # @OutputOnly |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 109 | "build": { # A build resource in the Container Builder API. # Contents of the build template. |
| 110 | # |
| 111 | # At a high level, a Build describes where to find source code, how to build |
| 112 | # it (for example, the builder image to run on the source), and what tag to |
| 113 | # apply to the built image when it is pushed to Google Container Registry. |
| 114 | "status": "A String", # Status of the build. |
| 115 | # @OutputOnly |
| 116 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 117 | # @OutputOnly |
| 118 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second |
| 119 | # granularity. If this amount of time elapses, work on the build will cease |
| 120 | # and the build status will be TIMEOUT. |
| 121 | # |
| 122 | # Default time is ten minutes. |
| 123 | "statusDetail": "A String", # Customer-readable message about the current status. |
| 124 | # @OutputOnly |
| 125 | "startTime": "A String", # Time at which execution of the build was started. |
| 126 | # @OutputOnly |
| 127 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see |
| 128 | # [Bucket Name |
| 129 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 130 | # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| 131 | "results": { # Results describes the artifacts created by the build pipeline. # Results of the build. |
| 132 | # @OutputOnly |
| 133 | "images": [ # Images that were built as a part of the build. |
| 134 | { # BuiltImage describes an image built by the pipeline. |
| 135 | "name": "A String", # Name used to push the container image to Google Container Registry, as |
| 136 | # presented to `docker push`. |
| 137 | "digest": "A String", # Docker Registry 2.0 digest. |
| 138 | }, |
| 139 | ], |
| 140 | "buildStepImages": [ # List of build step digests, in order corresponding to build step indices. |
| 141 | "A String", |
| 142 | ], |
| 143 | }, |
| 144 | "createTime": "A String", # Time at which the build was created. |
| 145 | # @OutputOnly |
| 146 | "id": "A String", # Unique identifier of the build. |
| 147 | # @OutputOnly |
| 148 | "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build. |
| 149 | # service. |
| 150 | "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud |
| 151 | # Storage. |
| 152 | # Google Cloud Storage. |
| 153 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 154 | # omitted, the latest generation will be used. |
| 155 | "object": "A String", # Google Cloud Storage object containing source. |
| 156 | # |
| 157 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 158 | # build. |
| 159 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 160 | # [Bucket Name |
| 161 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 162 | }, |
| 163 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo. |
| 164 | # Repository. |
| 165 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 166 | # the build is assumed. |
| 167 | "branchName": "A String", # Name of the branch to build. |
| 168 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 169 | "tagName": "A String", # Name of the tag to build. |
| 170 | "commitSha": "A String", # Explicit commit SHA to build. |
| 171 | }, |
| 172 | }, |
| 173 | "steps": [ # Describes the operations to be performed on the workspace. |
| 174 | { # BuildStep describes a step to perform in the build pipeline. |
| 175 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. |
| 176 | # This build step will not start until all the build steps in wait_for |
| 177 | # have completed successfully. If wait_for is empty, this build step will |
| 178 | # start when all previous build steps in the Build.Steps list have completed |
| 179 | # successfully. |
| 180 | "A String", |
| 181 | ], |
| 182 | "name": "A String", # Name of the container image to use for creating this stage in the |
| 183 | # pipeline, as presented to `docker pull`. |
| 184 | "args": [ # Command-line arguments to use when running this step's container. |
| 185 | "A String", |
| 186 | ], |
| 187 | "env": [ # Additional environment variables to set for this step's container. |
| 188 | "A String", |
| 189 | ], |
| 190 | "id": "A String", # Optional unique identifier for this build step, used in wait_for to |
| 191 | # reference this build step as a dependency. |
| 192 | "dir": "A String", # Working directory (relative to project source root) to use when running |
| 193 | # this operation's container. |
| 194 | }, |
| 195 | ], |
| 196 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source. |
| 197 | # @OutputOnly |
| 198 | # some source was used for this build. |
| 199 | "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any |
| 200 | # revisions resolved. |
| 201 | # Repository. |
| 202 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 203 | # the build is assumed. |
| 204 | "branchName": "A String", # Name of the branch to build. |
| 205 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 206 | "tagName": "A String", # Name of the tag to build. |
| 207 | "commitSha": "A String", # Explicit commit SHA to build. |
| 208 | }, |
| 209 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original |
| 210 | # source integrity was maintained in the build. Note that FileHashes will |
| 211 | # only be populated if BuildOptions has requested a SourceProvenanceHash. |
| 212 | # |
| 213 | # The keys to this map are file paths used as build source and the values |
| 214 | # contain the hash values for those files. |
| 215 | # |
| 216 | # If the build source came in a single package such as a gzipped tarfile |
| 217 | # (.tar.gz), the FileHash will be for the single path to that file. |
| 218 | # @OutputOnly |
| 219 | "a_key": { # Container message for hashes of byte content of files, used in |
| 220 | # SourceProvenance messages to verify integrity of source input to the build. |
| 221 | "fileHash": [ # Collection of file hashes. |
| 222 | { # Container message for hash values. |
| 223 | "type": "A String", # The type of hash that was performed. |
| 224 | "value": "A String", # The hash value. |
| 225 | }, |
| 226 | ], |
| 227 | }, |
| 228 | }, |
| 229 | "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any |
| 230 | # generations resolved. |
| 231 | # Google Cloud Storage. |
| 232 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 233 | # omitted, the latest generation will be used. |
| 234 | "object": "A String", # Google Cloud Storage object containing source. |
| 235 | # |
| 236 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 237 | # build. |
| 238 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 239 | # [Bucket Name |
| 240 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 241 | }, |
| 242 | }, |
| 243 | "projectId": "A String", # ID of the project. |
| 244 | # @OutputOnly. |
| 245 | "images": [ # List of images expected to be built and pushed to Google Container |
| 246 | # Registry. If an image is listed here and the image is not produced by |
| 247 | # one of the build steps, the build will fail. Any images present when |
| 248 | # the build steps are complete will be pushed to Container Registry. |
| 249 | "A String", |
| 250 | ], |
| 251 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 252 | "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API. |
| 253 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 254 | "A String", |
| 255 | ], |
| 256 | }, |
| 257 | "logUrl": "A String", # URL to logs for this build in Google Cloud Logging. |
| 258 | # @OutputOnly |
| 259 | }, |
Jon Wayne Parrott | 2512a0c | 2016-08-29 10:21:22 -0700 | [diff] [blame] | 260 | "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build. |
| 261 | # |
| 262 | # Branch and tag names in trigger templates are interpreted as regular |
| 263 | # expressions. Any branch or tag change that matches that regular expression |
| 264 | # will trigger a build. |
| 265 | # Repository. |
| 266 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 267 | # the build is assumed. |
| 268 | "branchName": "A String", # Name of the branch to build. |
| 269 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 270 | "tagName": "A String", # Name of the tag to build. |
| 271 | "commitSha": "A String", # Explicit commit SHA to build. |
| 272 | }, |
| 273 | "createTime": "A String", # Time when the trigger was created. |
| 274 | # |
| 275 | # @OutputOnly |
| 276 | "filename": "A String", # Path, from the source root, to a file whose contents is used for the |
| 277 | # template. |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 278 | } |
| 279 | |
| 280 | x__xgafv: string, V1 error format. |
| 281 | Allowed values |
| 282 | 1 - v1 error format |
| 283 | 2 - v2 error format |
| 284 | |
| 285 | Returns: |
| 286 | An object of the form: |
| 287 | |
| 288 | { # Configuration for an automated build in response to source repository |
| 289 | # changes. |
| 290 | "id": "A String", # Unique identifier of the trigger. |
| 291 | # |
| 292 | # @OutputOnly |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 293 | "build": { # A build resource in the Container Builder API. # Contents of the build template. |
| 294 | # |
| 295 | # At a high level, a Build describes where to find source code, how to build |
| 296 | # it (for example, the builder image to run on the source), and what tag to |
| 297 | # apply to the built image when it is pushed to Google Container Registry. |
| 298 | "status": "A String", # Status of the build. |
| 299 | # @OutputOnly |
| 300 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 301 | # @OutputOnly |
| 302 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second |
| 303 | # granularity. If this amount of time elapses, work on the build will cease |
| 304 | # and the build status will be TIMEOUT. |
| 305 | # |
| 306 | # Default time is ten minutes. |
| 307 | "statusDetail": "A String", # Customer-readable message about the current status. |
| 308 | # @OutputOnly |
| 309 | "startTime": "A String", # Time at which execution of the build was started. |
| 310 | # @OutputOnly |
| 311 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see |
| 312 | # [Bucket Name |
| 313 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 314 | # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| 315 | "results": { # Results describes the artifacts created by the build pipeline. # Results of the build. |
| 316 | # @OutputOnly |
| 317 | "images": [ # Images that were built as a part of the build. |
| 318 | { # BuiltImage describes an image built by the pipeline. |
| 319 | "name": "A String", # Name used to push the container image to Google Container Registry, as |
| 320 | # presented to `docker push`. |
| 321 | "digest": "A String", # Docker Registry 2.0 digest. |
| 322 | }, |
| 323 | ], |
| 324 | "buildStepImages": [ # List of build step digests, in order corresponding to build step indices. |
| 325 | "A String", |
| 326 | ], |
| 327 | }, |
| 328 | "createTime": "A String", # Time at which the build was created. |
| 329 | # @OutputOnly |
| 330 | "id": "A String", # Unique identifier of the build. |
| 331 | # @OutputOnly |
| 332 | "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build. |
| 333 | # service. |
| 334 | "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud |
| 335 | # Storage. |
| 336 | # Google Cloud Storage. |
| 337 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 338 | # omitted, the latest generation will be used. |
| 339 | "object": "A String", # Google Cloud Storage object containing source. |
| 340 | # |
| 341 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 342 | # build. |
| 343 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 344 | # [Bucket Name |
| 345 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 346 | }, |
| 347 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo. |
| 348 | # Repository. |
| 349 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 350 | # the build is assumed. |
| 351 | "branchName": "A String", # Name of the branch to build. |
| 352 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 353 | "tagName": "A String", # Name of the tag to build. |
| 354 | "commitSha": "A String", # Explicit commit SHA to build. |
| 355 | }, |
| 356 | }, |
| 357 | "steps": [ # Describes the operations to be performed on the workspace. |
| 358 | { # BuildStep describes a step to perform in the build pipeline. |
| 359 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. |
| 360 | # This build step will not start until all the build steps in wait_for |
| 361 | # have completed successfully. If wait_for is empty, this build step will |
| 362 | # start when all previous build steps in the Build.Steps list have completed |
| 363 | # successfully. |
| 364 | "A String", |
| 365 | ], |
| 366 | "name": "A String", # Name of the container image to use for creating this stage in the |
| 367 | # pipeline, as presented to `docker pull`. |
| 368 | "args": [ # Command-line arguments to use when running this step's container. |
| 369 | "A String", |
| 370 | ], |
| 371 | "env": [ # Additional environment variables to set for this step's container. |
| 372 | "A String", |
| 373 | ], |
| 374 | "id": "A String", # Optional unique identifier for this build step, used in wait_for to |
| 375 | # reference this build step as a dependency. |
| 376 | "dir": "A String", # Working directory (relative to project source root) to use when running |
| 377 | # this operation's container. |
| 378 | }, |
| 379 | ], |
| 380 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source. |
| 381 | # @OutputOnly |
| 382 | # some source was used for this build. |
| 383 | "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any |
| 384 | # revisions resolved. |
| 385 | # Repository. |
| 386 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 387 | # the build is assumed. |
| 388 | "branchName": "A String", # Name of the branch to build. |
| 389 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 390 | "tagName": "A String", # Name of the tag to build. |
| 391 | "commitSha": "A String", # Explicit commit SHA to build. |
| 392 | }, |
| 393 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original |
| 394 | # source integrity was maintained in the build. Note that FileHashes will |
| 395 | # only be populated if BuildOptions has requested a SourceProvenanceHash. |
| 396 | # |
| 397 | # The keys to this map are file paths used as build source and the values |
| 398 | # contain the hash values for those files. |
| 399 | # |
| 400 | # If the build source came in a single package such as a gzipped tarfile |
| 401 | # (.tar.gz), the FileHash will be for the single path to that file. |
| 402 | # @OutputOnly |
| 403 | "a_key": { # Container message for hashes of byte content of files, used in |
| 404 | # SourceProvenance messages to verify integrity of source input to the build. |
| 405 | "fileHash": [ # Collection of file hashes. |
| 406 | { # Container message for hash values. |
| 407 | "type": "A String", # The type of hash that was performed. |
| 408 | "value": "A String", # The hash value. |
| 409 | }, |
| 410 | ], |
| 411 | }, |
| 412 | }, |
| 413 | "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any |
| 414 | # generations resolved. |
| 415 | # Google Cloud Storage. |
| 416 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 417 | # omitted, the latest generation will be used. |
| 418 | "object": "A String", # Google Cloud Storage object containing source. |
| 419 | # |
| 420 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 421 | # build. |
| 422 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 423 | # [Bucket Name |
| 424 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 425 | }, |
| 426 | }, |
| 427 | "projectId": "A String", # ID of the project. |
| 428 | # @OutputOnly. |
| 429 | "images": [ # List of images expected to be built and pushed to Google Container |
| 430 | # Registry. If an image is listed here and the image is not produced by |
| 431 | # one of the build steps, the build will fail. Any images present when |
| 432 | # the build steps are complete will be pushed to Container Registry. |
| 433 | "A String", |
| 434 | ], |
| 435 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 436 | "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API. |
| 437 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 438 | "A String", |
| 439 | ], |
| 440 | }, |
| 441 | "logUrl": "A String", # URL to logs for this build in Google Cloud Logging. |
| 442 | # @OutputOnly |
| 443 | }, |
Jon Wayne Parrott | 2512a0c | 2016-08-29 10:21:22 -0700 | [diff] [blame] | 444 | "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build. |
| 445 | # |
| 446 | # Branch and tag names in trigger templates are interpreted as regular |
| 447 | # expressions. Any branch or tag change that matches that regular expression |
| 448 | # will trigger a build. |
| 449 | # Repository. |
| 450 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 451 | # the build is assumed. |
| 452 | "branchName": "A String", # Name of the branch to build. |
| 453 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 454 | "tagName": "A String", # Name of the tag to build. |
| 455 | "commitSha": "A String", # Explicit commit SHA to build. |
| 456 | }, |
| 457 | "createTime": "A String", # Time when the trigger was created. |
| 458 | # |
| 459 | # @OutputOnly |
| 460 | "filename": "A String", # Path, from the source root, to a file whose contents is used for the |
| 461 | # template. |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 462 | }</pre> |
| 463 | </div> |
| 464 | |
| 465 | <div class="method"> |
| 466 | <code class="details" id="delete">delete(projectId, triggerId, x__xgafv=None)</code> |
| 467 | <pre>Deletes an BuildTrigger by its project ID and trigger ID. |
| 468 | |
| 469 | This API is experimental. |
| 470 | |
| 471 | Args: |
| 472 | projectId: string, ID of the project that owns the trigger. (required) |
| 473 | triggerId: string, ID of the BuildTrigger to delete. (required) |
| 474 | x__xgafv: string, V1 error format. |
| 475 | Allowed values |
| 476 | 1 - v1 error format |
| 477 | 2 - v2 error format |
| 478 | |
| 479 | Returns: |
| 480 | An object of the form: |
| 481 | |
| 482 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 483 | # empty messages in your APIs. A typical example is to use it as the request |
| 484 | # or the response type of an API method. For instance: |
| 485 | # |
| 486 | # service Foo { |
| 487 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 488 | # } |
| 489 | # |
| 490 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 491 | }</pre> |
| 492 | </div> |
| 493 | |
| 494 | <div class="method"> |
| 495 | <code class="details" id="get">get(projectId, triggerId, x__xgafv=None)</code> |
| 496 | <pre>Gets information about a BuildTrigger. |
| 497 | |
| 498 | This API is experimental. |
| 499 | |
| 500 | Args: |
| 501 | projectId: string, ID of the project that owns the trigger. (required) |
| 502 | triggerId: string, ID of the BuildTrigger to get. (required) |
| 503 | x__xgafv: string, V1 error format. |
| 504 | Allowed values |
| 505 | 1 - v1 error format |
| 506 | 2 - v2 error format |
| 507 | |
| 508 | Returns: |
| 509 | An object of the form: |
| 510 | |
| 511 | { # Configuration for an automated build in response to source repository |
| 512 | # changes. |
| 513 | "id": "A String", # Unique identifier of the trigger. |
| 514 | # |
| 515 | # @OutputOnly |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 516 | "build": { # A build resource in the Container Builder API. # Contents of the build template. |
| 517 | # |
| 518 | # At a high level, a Build describes where to find source code, how to build |
| 519 | # it (for example, the builder image to run on the source), and what tag to |
| 520 | # apply to the built image when it is pushed to Google Container Registry. |
| 521 | "status": "A String", # Status of the build. |
| 522 | # @OutputOnly |
| 523 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 524 | # @OutputOnly |
| 525 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second |
| 526 | # granularity. If this amount of time elapses, work on the build will cease |
| 527 | # and the build status will be TIMEOUT. |
| 528 | # |
| 529 | # Default time is ten minutes. |
| 530 | "statusDetail": "A String", # Customer-readable message about the current status. |
| 531 | # @OutputOnly |
| 532 | "startTime": "A String", # Time at which execution of the build was started. |
| 533 | # @OutputOnly |
| 534 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see |
| 535 | # [Bucket Name |
| 536 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 537 | # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| 538 | "results": { # Results describes the artifacts created by the build pipeline. # Results of the build. |
| 539 | # @OutputOnly |
| 540 | "images": [ # Images that were built as a part of the build. |
| 541 | { # BuiltImage describes an image built by the pipeline. |
| 542 | "name": "A String", # Name used to push the container image to Google Container Registry, as |
| 543 | # presented to `docker push`. |
| 544 | "digest": "A String", # Docker Registry 2.0 digest. |
| 545 | }, |
| 546 | ], |
| 547 | "buildStepImages": [ # List of build step digests, in order corresponding to build step indices. |
| 548 | "A String", |
| 549 | ], |
| 550 | }, |
| 551 | "createTime": "A String", # Time at which the build was created. |
| 552 | # @OutputOnly |
| 553 | "id": "A String", # Unique identifier of the build. |
| 554 | # @OutputOnly |
| 555 | "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build. |
| 556 | # service. |
| 557 | "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud |
| 558 | # Storage. |
| 559 | # Google Cloud Storage. |
| 560 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 561 | # omitted, the latest generation will be used. |
| 562 | "object": "A String", # Google Cloud Storage object containing source. |
| 563 | # |
| 564 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 565 | # build. |
| 566 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 567 | # [Bucket Name |
| 568 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 569 | }, |
| 570 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo. |
| 571 | # Repository. |
| 572 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 573 | # the build is assumed. |
| 574 | "branchName": "A String", # Name of the branch to build. |
| 575 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 576 | "tagName": "A String", # Name of the tag to build. |
| 577 | "commitSha": "A String", # Explicit commit SHA to build. |
| 578 | }, |
| 579 | }, |
| 580 | "steps": [ # Describes the operations to be performed on the workspace. |
| 581 | { # BuildStep describes a step to perform in the build pipeline. |
| 582 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. |
| 583 | # This build step will not start until all the build steps in wait_for |
| 584 | # have completed successfully. If wait_for is empty, this build step will |
| 585 | # start when all previous build steps in the Build.Steps list have completed |
| 586 | # successfully. |
| 587 | "A String", |
| 588 | ], |
| 589 | "name": "A String", # Name of the container image to use for creating this stage in the |
| 590 | # pipeline, as presented to `docker pull`. |
| 591 | "args": [ # Command-line arguments to use when running this step's container. |
| 592 | "A String", |
| 593 | ], |
| 594 | "env": [ # Additional environment variables to set for this step's container. |
| 595 | "A String", |
| 596 | ], |
| 597 | "id": "A String", # Optional unique identifier for this build step, used in wait_for to |
| 598 | # reference this build step as a dependency. |
| 599 | "dir": "A String", # Working directory (relative to project source root) to use when running |
| 600 | # this operation's container. |
| 601 | }, |
| 602 | ], |
| 603 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source. |
| 604 | # @OutputOnly |
| 605 | # some source was used for this build. |
| 606 | "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any |
| 607 | # revisions resolved. |
| 608 | # Repository. |
| 609 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 610 | # the build is assumed. |
| 611 | "branchName": "A String", # Name of the branch to build. |
| 612 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 613 | "tagName": "A String", # Name of the tag to build. |
| 614 | "commitSha": "A String", # Explicit commit SHA to build. |
| 615 | }, |
| 616 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original |
| 617 | # source integrity was maintained in the build. Note that FileHashes will |
| 618 | # only be populated if BuildOptions has requested a SourceProvenanceHash. |
| 619 | # |
| 620 | # The keys to this map are file paths used as build source and the values |
| 621 | # contain the hash values for those files. |
| 622 | # |
| 623 | # If the build source came in a single package such as a gzipped tarfile |
| 624 | # (.tar.gz), the FileHash will be for the single path to that file. |
| 625 | # @OutputOnly |
| 626 | "a_key": { # Container message for hashes of byte content of files, used in |
| 627 | # SourceProvenance messages to verify integrity of source input to the build. |
| 628 | "fileHash": [ # Collection of file hashes. |
| 629 | { # Container message for hash values. |
| 630 | "type": "A String", # The type of hash that was performed. |
| 631 | "value": "A String", # The hash value. |
| 632 | }, |
| 633 | ], |
| 634 | }, |
| 635 | }, |
| 636 | "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any |
| 637 | # generations resolved. |
| 638 | # Google Cloud Storage. |
| 639 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 640 | # omitted, the latest generation will be used. |
| 641 | "object": "A String", # Google Cloud Storage object containing source. |
| 642 | # |
| 643 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 644 | # build. |
| 645 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 646 | # [Bucket Name |
| 647 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 648 | }, |
| 649 | }, |
| 650 | "projectId": "A String", # ID of the project. |
| 651 | # @OutputOnly. |
| 652 | "images": [ # List of images expected to be built and pushed to Google Container |
| 653 | # Registry. If an image is listed here and the image is not produced by |
| 654 | # one of the build steps, the build will fail. Any images present when |
| 655 | # the build steps are complete will be pushed to Container Registry. |
| 656 | "A String", |
| 657 | ], |
| 658 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 659 | "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API. |
| 660 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 661 | "A String", |
| 662 | ], |
| 663 | }, |
| 664 | "logUrl": "A String", # URL to logs for this build in Google Cloud Logging. |
| 665 | # @OutputOnly |
| 666 | }, |
Jon Wayne Parrott | 2512a0c | 2016-08-29 10:21:22 -0700 | [diff] [blame] | 667 | "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build. |
| 668 | # |
| 669 | # Branch and tag names in trigger templates are interpreted as regular |
| 670 | # expressions. Any branch or tag change that matches that regular expression |
| 671 | # will trigger a build. |
| 672 | # Repository. |
| 673 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 674 | # the build is assumed. |
| 675 | "branchName": "A String", # Name of the branch to build. |
| 676 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 677 | "tagName": "A String", # Name of the tag to build. |
| 678 | "commitSha": "A String", # Explicit commit SHA to build. |
| 679 | }, |
| 680 | "createTime": "A String", # Time when the trigger was created. |
| 681 | # |
| 682 | # @OutputOnly |
| 683 | "filename": "A String", # Path, from the source root, to a file whose contents is used for the |
| 684 | # template. |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 685 | }</pre> |
| 686 | </div> |
| 687 | |
| 688 | <div class="method"> |
| 689 | <code class="details" id="list">list(projectId, x__xgafv=None)</code> |
| 690 | <pre>Lists existing BuildTrigger. |
| 691 | |
| 692 | This API is experimental. |
| 693 | |
| 694 | Args: |
| 695 | projectId: string, ID of the project for which to list BuildTriggers. (required) |
| 696 | x__xgafv: string, V1 error format. |
| 697 | Allowed values |
| 698 | 1 - v1 error format |
| 699 | 2 - v2 error format |
| 700 | |
| 701 | Returns: |
| 702 | An object of the form: |
| 703 | |
| 704 | { # Response containing existing BuildTriggers. |
| 705 | "triggers": [ # BuildTriggers for the project, sorted by create_time descending. |
| 706 | { # Configuration for an automated build in response to source repository |
| 707 | # changes. |
| 708 | "id": "A String", # Unique identifier of the trigger. |
| 709 | # |
| 710 | # @OutputOnly |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 711 | "build": { # A build resource in the Container Builder API. # Contents of the build template. |
| 712 | # |
| 713 | # At a high level, a Build describes where to find source code, how to build |
| 714 | # it (for example, the builder image to run on the source), and what tag to |
| 715 | # apply to the built image when it is pushed to Google Container Registry. |
| 716 | "status": "A String", # Status of the build. |
| 717 | # @OutputOnly |
| 718 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 719 | # @OutputOnly |
| 720 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second |
| 721 | # granularity. If this amount of time elapses, work on the build will cease |
| 722 | # and the build status will be TIMEOUT. |
| 723 | # |
| 724 | # Default time is ten minutes. |
| 725 | "statusDetail": "A String", # Customer-readable message about the current status. |
| 726 | # @OutputOnly |
| 727 | "startTime": "A String", # Time at which execution of the build was started. |
| 728 | # @OutputOnly |
| 729 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see |
| 730 | # [Bucket Name |
| 731 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 732 | # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| 733 | "results": { # Results describes the artifacts created by the build pipeline. # Results of the build. |
| 734 | # @OutputOnly |
| 735 | "images": [ # Images that were built as a part of the build. |
| 736 | { # BuiltImage describes an image built by the pipeline. |
| 737 | "name": "A String", # Name used to push the container image to Google Container Registry, as |
| 738 | # presented to `docker push`. |
| 739 | "digest": "A String", # Docker Registry 2.0 digest. |
| 740 | }, |
| 741 | ], |
| 742 | "buildStepImages": [ # List of build step digests, in order corresponding to build step indices. |
| 743 | "A String", |
| 744 | ], |
| 745 | }, |
| 746 | "createTime": "A String", # Time at which the build was created. |
| 747 | # @OutputOnly |
| 748 | "id": "A String", # Unique identifier of the build. |
| 749 | # @OutputOnly |
| 750 | "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build. |
| 751 | # service. |
| 752 | "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud |
| 753 | # Storage. |
| 754 | # Google Cloud Storage. |
| 755 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 756 | # omitted, the latest generation will be used. |
| 757 | "object": "A String", # Google Cloud Storage object containing source. |
| 758 | # |
| 759 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 760 | # build. |
| 761 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 762 | # [Bucket Name |
| 763 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 764 | }, |
| 765 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo. |
| 766 | # Repository. |
| 767 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 768 | # the build is assumed. |
| 769 | "branchName": "A String", # Name of the branch to build. |
| 770 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 771 | "tagName": "A String", # Name of the tag to build. |
| 772 | "commitSha": "A String", # Explicit commit SHA to build. |
| 773 | }, |
| 774 | }, |
| 775 | "steps": [ # Describes the operations to be performed on the workspace. |
| 776 | { # BuildStep describes a step to perform in the build pipeline. |
| 777 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. |
| 778 | # This build step will not start until all the build steps in wait_for |
| 779 | # have completed successfully. If wait_for is empty, this build step will |
| 780 | # start when all previous build steps in the Build.Steps list have completed |
| 781 | # successfully. |
| 782 | "A String", |
| 783 | ], |
| 784 | "name": "A String", # Name of the container image to use for creating this stage in the |
| 785 | # pipeline, as presented to `docker pull`. |
| 786 | "args": [ # Command-line arguments to use when running this step's container. |
| 787 | "A String", |
| 788 | ], |
| 789 | "env": [ # Additional environment variables to set for this step's container. |
| 790 | "A String", |
| 791 | ], |
| 792 | "id": "A String", # Optional unique identifier for this build step, used in wait_for to |
| 793 | # reference this build step as a dependency. |
| 794 | "dir": "A String", # Working directory (relative to project source root) to use when running |
| 795 | # this operation's container. |
| 796 | }, |
| 797 | ], |
| 798 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source. |
| 799 | # @OutputOnly |
| 800 | # some source was used for this build. |
| 801 | "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any |
| 802 | # revisions resolved. |
| 803 | # Repository. |
| 804 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 805 | # the build is assumed. |
| 806 | "branchName": "A String", # Name of the branch to build. |
| 807 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 808 | "tagName": "A String", # Name of the tag to build. |
| 809 | "commitSha": "A String", # Explicit commit SHA to build. |
| 810 | }, |
| 811 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original |
| 812 | # source integrity was maintained in the build. Note that FileHashes will |
| 813 | # only be populated if BuildOptions has requested a SourceProvenanceHash. |
| 814 | # |
| 815 | # The keys to this map are file paths used as build source and the values |
| 816 | # contain the hash values for those files. |
| 817 | # |
| 818 | # If the build source came in a single package such as a gzipped tarfile |
| 819 | # (.tar.gz), the FileHash will be for the single path to that file. |
| 820 | # @OutputOnly |
| 821 | "a_key": { # Container message for hashes of byte content of files, used in |
| 822 | # SourceProvenance messages to verify integrity of source input to the build. |
| 823 | "fileHash": [ # Collection of file hashes. |
| 824 | { # Container message for hash values. |
| 825 | "type": "A String", # The type of hash that was performed. |
| 826 | "value": "A String", # The hash value. |
| 827 | }, |
| 828 | ], |
| 829 | }, |
| 830 | }, |
| 831 | "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any |
| 832 | # generations resolved. |
| 833 | # Google Cloud Storage. |
| 834 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 835 | # omitted, the latest generation will be used. |
| 836 | "object": "A String", # Google Cloud Storage object containing source. |
| 837 | # |
| 838 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 839 | # build. |
| 840 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 841 | # [Bucket Name |
| 842 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 843 | }, |
| 844 | }, |
| 845 | "projectId": "A String", # ID of the project. |
| 846 | # @OutputOnly. |
| 847 | "images": [ # List of images expected to be built and pushed to Google Container |
| 848 | # Registry. If an image is listed here and the image is not produced by |
| 849 | # one of the build steps, the build will fail. Any images present when |
| 850 | # the build steps are complete will be pushed to Container Registry. |
| 851 | "A String", |
| 852 | ], |
| 853 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 854 | "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API. |
| 855 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 856 | "A String", |
| 857 | ], |
| 858 | }, |
| 859 | "logUrl": "A String", # URL to logs for this build in Google Cloud Logging. |
| 860 | # @OutputOnly |
| 861 | }, |
Jon Wayne Parrott | 2512a0c | 2016-08-29 10:21:22 -0700 | [diff] [blame] | 862 | "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build. |
| 863 | # |
| 864 | # Branch and tag names in trigger templates are interpreted as regular |
| 865 | # expressions. Any branch or tag change that matches that regular expression |
| 866 | # will trigger a build. |
| 867 | # Repository. |
| 868 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 869 | # the build is assumed. |
| 870 | "branchName": "A String", # Name of the branch to build. |
| 871 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 872 | "tagName": "A String", # Name of the tag to build. |
| 873 | "commitSha": "A String", # Explicit commit SHA to build. |
| 874 | }, |
| 875 | "createTime": "A String", # Time when the trigger was created. |
| 876 | # |
| 877 | # @OutputOnly |
| 878 | "filename": "A String", # Path, from the source root, to a file whose contents is used for the |
| 879 | # template. |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 880 | }, |
| 881 | ], |
| 882 | }</pre> |
| 883 | </div> |
| 884 | |
| 885 | <div class="method"> |
| 886 | <code class="details" id="patch">patch(projectId, triggerId, body, x__xgafv=None)</code> |
| 887 | <pre>Updates an BuildTrigger by its project ID and trigger ID. |
| 888 | |
| 889 | This API is experimental. |
| 890 | |
| 891 | Args: |
| 892 | projectId: string, ID of the project that owns the trigger. (required) |
| 893 | triggerId: string, ID of the BuildTrigger to update. (required) |
| 894 | body: object, The request body. (required) |
| 895 | The object takes the form of: |
| 896 | |
| 897 | { # Configuration for an automated build in response to source repository |
| 898 | # changes. |
| 899 | "id": "A String", # Unique identifier of the trigger. |
| 900 | # |
| 901 | # @OutputOnly |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 902 | "build": { # A build resource in the Container Builder API. # Contents of the build template. |
| 903 | # |
| 904 | # At a high level, a Build describes where to find source code, how to build |
| 905 | # it (for example, the builder image to run on the source), and what tag to |
| 906 | # apply to the built image when it is pushed to Google Container Registry. |
| 907 | "status": "A String", # Status of the build. |
| 908 | # @OutputOnly |
| 909 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 910 | # @OutputOnly |
| 911 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second |
| 912 | # granularity. If this amount of time elapses, work on the build will cease |
| 913 | # and the build status will be TIMEOUT. |
| 914 | # |
| 915 | # Default time is ten minutes. |
| 916 | "statusDetail": "A String", # Customer-readable message about the current status. |
| 917 | # @OutputOnly |
| 918 | "startTime": "A String", # Time at which execution of the build was started. |
| 919 | # @OutputOnly |
| 920 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see |
| 921 | # [Bucket Name |
| 922 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 923 | # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| 924 | "results": { # Results describes the artifacts created by the build pipeline. # Results of the build. |
| 925 | # @OutputOnly |
| 926 | "images": [ # Images that were built as a part of the build. |
| 927 | { # BuiltImage describes an image built by the pipeline. |
| 928 | "name": "A String", # Name used to push the container image to Google Container Registry, as |
| 929 | # presented to `docker push`. |
| 930 | "digest": "A String", # Docker Registry 2.0 digest. |
| 931 | }, |
| 932 | ], |
| 933 | "buildStepImages": [ # List of build step digests, in order corresponding to build step indices. |
| 934 | "A String", |
| 935 | ], |
| 936 | }, |
| 937 | "createTime": "A String", # Time at which the build was created. |
| 938 | # @OutputOnly |
| 939 | "id": "A String", # Unique identifier of the build. |
| 940 | # @OutputOnly |
| 941 | "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build. |
| 942 | # service. |
| 943 | "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud |
| 944 | # Storage. |
| 945 | # Google Cloud Storage. |
| 946 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 947 | # omitted, the latest generation will be used. |
| 948 | "object": "A String", # Google Cloud Storage object containing source. |
| 949 | # |
| 950 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 951 | # build. |
| 952 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 953 | # [Bucket Name |
| 954 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 955 | }, |
| 956 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo. |
| 957 | # Repository. |
| 958 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 959 | # the build is assumed. |
| 960 | "branchName": "A String", # Name of the branch to build. |
| 961 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 962 | "tagName": "A String", # Name of the tag to build. |
| 963 | "commitSha": "A String", # Explicit commit SHA to build. |
| 964 | }, |
| 965 | }, |
| 966 | "steps": [ # Describes the operations to be performed on the workspace. |
| 967 | { # BuildStep describes a step to perform in the build pipeline. |
| 968 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. |
| 969 | # This build step will not start until all the build steps in wait_for |
| 970 | # have completed successfully. If wait_for is empty, this build step will |
| 971 | # start when all previous build steps in the Build.Steps list have completed |
| 972 | # successfully. |
| 973 | "A String", |
| 974 | ], |
| 975 | "name": "A String", # Name of the container image to use for creating this stage in the |
| 976 | # pipeline, as presented to `docker pull`. |
| 977 | "args": [ # Command-line arguments to use when running this step's container. |
| 978 | "A String", |
| 979 | ], |
| 980 | "env": [ # Additional environment variables to set for this step's container. |
| 981 | "A String", |
| 982 | ], |
| 983 | "id": "A String", # Optional unique identifier for this build step, used in wait_for to |
| 984 | # reference this build step as a dependency. |
| 985 | "dir": "A String", # Working directory (relative to project source root) to use when running |
| 986 | # this operation's container. |
| 987 | }, |
| 988 | ], |
| 989 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source. |
| 990 | # @OutputOnly |
| 991 | # some source was used for this build. |
| 992 | "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any |
| 993 | # revisions resolved. |
| 994 | # Repository. |
| 995 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 996 | # the build is assumed. |
| 997 | "branchName": "A String", # Name of the branch to build. |
| 998 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 999 | "tagName": "A String", # Name of the tag to build. |
| 1000 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1001 | }, |
| 1002 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original |
| 1003 | # source integrity was maintained in the build. Note that FileHashes will |
| 1004 | # only be populated if BuildOptions has requested a SourceProvenanceHash. |
| 1005 | # |
| 1006 | # The keys to this map are file paths used as build source and the values |
| 1007 | # contain the hash values for those files. |
| 1008 | # |
| 1009 | # If the build source came in a single package such as a gzipped tarfile |
| 1010 | # (.tar.gz), the FileHash will be for the single path to that file. |
| 1011 | # @OutputOnly |
| 1012 | "a_key": { # Container message for hashes of byte content of files, used in |
| 1013 | # SourceProvenance messages to verify integrity of source input to the build. |
| 1014 | "fileHash": [ # Collection of file hashes. |
| 1015 | { # Container message for hash values. |
| 1016 | "type": "A String", # The type of hash that was performed. |
| 1017 | "value": "A String", # The hash value. |
| 1018 | }, |
| 1019 | ], |
| 1020 | }, |
| 1021 | }, |
| 1022 | "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any |
| 1023 | # generations resolved. |
| 1024 | # Google Cloud Storage. |
| 1025 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 1026 | # omitted, the latest generation will be used. |
| 1027 | "object": "A String", # Google Cloud Storage object containing source. |
| 1028 | # |
| 1029 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 1030 | # build. |
| 1031 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 1032 | # [Bucket Name |
| 1033 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1034 | }, |
| 1035 | }, |
| 1036 | "projectId": "A String", # ID of the project. |
| 1037 | # @OutputOnly. |
| 1038 | "images": [ # List of images expected to be built and pushed to Google Container |
| 1039 | # Registry. If an image is listed here and the image is not produced by |
| 1040 | # one of the build steps, the build will fail. Any images present when |
| 1041 | # the build steps are complete will be pushed to Container Registry. |
| 1042 | "A String", |
| 1043 | ], |
| 1044 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 1045 | "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API. |
| 1046 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 1047 | "A String", |
| 1048 | ], |
| 1049 | }, |
| 1050 | "logUrl": "A String", # URL to logs for this build in Google Cloud Logging. |
| 1051 | # @OutputOnly |
| 1052 | }, |
Jon Wayne Parrott | 2512a0c | 2016-08-29 10:21:22 -0700 | [diff] [blame] | 1053 | "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build. |
| 1054 | # |
| 1055 | # Branch and tag names in trigger templates are interpreted as regular |
| 1056 | # expressions. Any branch or tag change that matches that regular expression |
| 1057 | # will trigger a build. |
| 1058 | # Repository. |
| 1059 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 1060 | # the build is assumed. |
| 1061 | "branchName": "A String", # Name of the branch to build. |
| 1062 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 1063 | "tagName": "A String", # Name of the tag to build. |
| 1064 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1065 | }, |
| 1066 | "createTime": "A String", # Time when the trigger was created. |
| 1067 | # |
| 1068 | # @OutputOnly |
| 1069 | "filename": "A String", # Path, from the source root, to a file whose contents is used for the |
| 1070 | # template. |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1071 | } |
| 1072 | |
| 1073 | x__xgafv: string, V1 error format. |
| 1074 | Allowed values |
| 1075 | 1 - v1 error format |
| 1076 | 2 - v2 error format |
| 1077 | |
| 1078 | Returns: |
| 1079 | An object of the form: |
| 1080 | |
| 1081 | { # Configuration for an automated build in response to source repository |
| 1082 | # changes. |
| 1083 | "id": "A String", # Unique identifier of the trigger. |
| 1084 | # |
| 1085 | # @OutputOnly |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1086 | "build": { # A build resource in the Container Builder API. # Contents of the build template. |
| 1087 | # |
| 1088 | # At a high level, a Build describes where to find source code, how to build |
| 1089 | # it (for example, the builder image to run on the source), and what tag to |
| 1090 | # apply to the built image when it is pushed to Google Container Registry. |
| 1091 | "status": "A String", # Status of the build. |
| 1092 | # @OutputOnly |
| 1093 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 1094 | # @OutputOnly |
| 1095 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second |
| 1096 | # granularity. If this amount of time elapses, work on the build will cease |
| 1097 | # and the build status will be TIMEOUT. |
| 1098 | # |
| 1099 | # Default time is ten minutes. |
| 1100 | "statusDetail": "A String", # Customer-readable message about the current status. |
| 1101 | # @OutputOnly |
| 1102 | "startTime": "A String", # Time at which execution of the build was started. |
| 1103 | # @OutputOnly |
| 1104 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see |
| 1105 | # [Bucket Name |
| 1106 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1107 | # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| 1108 | "results": { # Results describes the artifacts created by the build pipeline. # Results of the build. |
| 1109 | # @OutputOnly |
| 1110 | "images": [ # Images that were built as a part of the build. |
| 1111 | { # BuiltImage describes an image built by the pipeline. |
| 1112 | "name": "A String", # Name used to push the container image to Google Container Registry, as |
| 1113 | # presented to `docker push`. |
| 1114 | "digest": "A String", # Docker Registry 2.0 digest. |
| 1115 | }, |
| 1116 | ], |
| 1117 | "buildStepImages": [ # List of build step digests, in order corresponding to build step indices. |
| 1118 | "A String", |
| 1119 | ], |
| 1120 | }, |
| 1121 | "createTime": "A String", # Time at which the build was created. |
| 1122 | # @OutputOnly |
| 1123 | "id": "A String", # Unique identifier of the build. |
| 1124 | # @OutputOnly |
| 1125 | "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build. |
| 1126 | # service. |
| 1127 | "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud |
| 1128 | # Storage. |
| 1129 | # Google Cloud Storage. |
| 1130 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 1131 | # omitted, the latest generation will be used. |
| 1132 | "object": "A String", # Google Cloud Storage object containing source. |
| 1133 | # |
| 1134 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 1135 | # build. |
| 1136 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 1137 | # [Bucket Name |
| 1138 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1139 | }, |
| 1140 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo. |
| 1141 | # Repository. |
| 1142 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 1143 | # the build is assumed. |
| 1144 | "branchName": "A String", # Name of the branch to build. |
| 1145 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 1146 | "tagName": "A String", # Name of the tag to build. |
| 1147 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1148 | }, |
| 1149 | }, |
| 1150 | "steps": [ # Describes the operations to be performed on the workspace. |
| 1151 | { # BuildStep describes a step to perform in the build pipeline. |
| 1152 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. |
| 1153 | # This build step will not start until all the build steps in wait_for |
| 1154 | # have completed successfully. If wait_for is empty, this build step will |
| 1155 | # start when all previous build steps in the Build.Steps list have completed |
| 1156 | # successfully. |
| 1157 | "A String", |
| 1158 | ], |
| 1159 | "name": "A String", # Name of the container image to use for creating this stage in the |
| 1160 | # pipeline, as presented to `docker pull`. |
| 1161 | "args": [ # Command-line arguments to use when running this step's container. |
| 1162 | "A String", |
| 1163 | ], |
| 1164 | "env": [ # Additional environment variables to set for this step's container. |
| 1165 | "A String", |
| 1166 | ], |
| 1167 | "id": "A String", # Optional unique identifier for this build step, used in wait_for to |
| 1168 | # reference this build step as a dependency. |
| 1169 | "dir": "A String", # Working directory (relative to project source root) to use when running |
| 1170 | # this operation's container. |
| 1171 | }, |
| 1172 | ], |
| 1173 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source. |
| 1174 | # @OutputOnly |
| 1175 | # some source was used for this build. |
| 1176 | "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any |
| 1177 | # revisions resolved. |
| 1178 | # Repository. |
| 1179 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 1180 | # the build is assumed. |
| 1181 | "branchName": "A String", # Name of the branch to build. |
| 1182 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 1183 | "tagName": "A String", # Name of the tag to build. |
| 1184 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1185 | }, |
| 1186 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original |
| 1187 | # source integrity was maintained in the build. Note that FileHashes will |
| 1188 | # only be populated if BuildOptions has requested a SourceProvenanceHash. |
| 1189 | # |
| 1190 | # The keys to this map are file paths used as build source and the values |
| 1191 | # contain the hash values for those files. |
| 1192 | # |
| 1193 | # If the build source came in a single package such as a gzipped tarfile |
| 1194 | # (.tar.gz), the FileHash will be for the single path to that file. |
| 1195 | # @OutputOnly |
| 1196 | "a_key": { # Container message for hashes of byte content of files, used in |
| 1197 | # SourceProvenance messages to verify integrity of source input to the build. |
| 1198 | "fileHash": [ # Collection of file hashes. |
| 1199 | { # Container message for hash values. |
| 1200 | "type": "A String", # The type of hash that was performed. |
| 1201 | "value": "A String", # The hash value. |
| 1202 | }, |
| 1203 | ], |
| 1204 | }, |
| 1205 | }, |
| 1206 | "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any |
| 1207 | # generations resolved. |
| 1208 | # Google Cloud Storage. |
| 1209 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is |
| 1210 | # omitted, the latest generation will be used. |
| 1211 | "object": "A String", # Google Cloud Storage object containing source. |
| 1212 | # |
| 1213 | # This object must be a gzipped archive file (.tar.gz) containing source to |
| 1214 | # build. |
| 1215 | "bucket": "A String", # Google Cloud Storage bucket containing source (see |
| 1216 | # [Bucket Name |
| 1217 | # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1218 | }, |
| 1219 | }, |
| 1220 | "projectId": "A String", # ID of the project. |
| 1221 | # @OutputOnly. |
| 1222 | "images": [ # List of images expected to be built and pushed to Google Container |
| 1223 | # Registry. If an image is listed here and the image is not produced by |
| 1224 | # one of the build steps, the build will fail. Any images present when |
| 1225 | # the build steps are complete will be pushed to Container Registry. |
| 1226 | "A String", |
| 1227 | ], |
| 1228 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| 1229 | "requestedVerifyOption": "A String", # Options for a verifiable build with details uploaded to the Analysis API. |
| 1230 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 1231 | "A String", |
| 1232 | ], |
| 1233 | }, |
| 1234 | "logUrl": "A String", # URL to logs for this build in Google Cloud Logging. |
| 1235 | # @OutputOnly |
| 1236 | }, |
Jon Wayne Parrott | 2512a0c | 2016-08-29 10:21:22 -0700 | [diff] [blame] | 1237 | "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build. |
| 1238 | # |
| 1239 | # Branch and tag names in trigger templates are interpreted as regular |
| 1240 | # expressions. Any branch or tag change that matches that regular expression |
| 1241 | # will trigger a build. |
| 1242 | # Repository. |
| 1243 | "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting |
| 1244 | # the build is assumed. |
| 1245 | "branchName": "A String", # Name of the branch to build. |
| 1246 | "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed. |
| 1247 | "tagName": "A String", # Name of the tag to build. |
| 1248 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1249 | }, |
| 1250 | "createTime": "A String", # Time when the trigger was created. |
| 1251 | # |
| 1252 | # @OutputOnly |
| 1253 | "filename": "A String", # Path, from the source root, to a file whose contents is used for the |
| 1254 | # template. |
Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 1255 | }</pre> |
| 1256 | </div> |
| 1257 | |
| 1258 | </body></html> |