Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / cloudbuild_v1.projects.triggers.html
blob: bf987496cec4f2ded44ddd4517af5af45084ff18 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
97This API is experimental.
98
99Args:
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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]106 "description": "A String", # Human-readable description of this trigger.
107 "createTime": "A String", # Time when the trigger was created.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]108 #
109 # @OutputOnly
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]110 "filename": "A String", # Path, from the source root, to a file whose contents is used for the
111 # template.
112 "disabled": True or False, # If true, the trigger will never result in a build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]113 "build": { # A build resource in the Container Builder API. # Contents of the build template.
114 #
115 # At a high level, a Build describes where to find source code, how to build
116 # it (for example, the builder image to run on the source), and what tag to
117 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]118 #
119 # Fields can include the following variables which will be expanded when the
120 # build is created:
121 #
122 # - $PROJECT_ID: the project ID of the build.
123 # - $BUILD_ID: the autogenerated ID of the build.
124 # - $REPO_NAME: the source repository name specified by RepoSource.
125 # - $BRANCH_NAME: the branch name specified by RepoSource.
126 # - $TAG_NAME: the tag name specified by RepoSource.
127 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
128 # resolved from the specified branch or tag.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]129 "status": "A String", # Status of the build.
130 # @OutputOnly
131 "finishTime": "A String", # Time at which execution of the build was finished.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]132 #
133 # The difference between finish_time and start_time is the duration of the
134 # build's execution.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]135 # @OutputOnly
136 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
137 # granularity. If this amount of time elapses, work on the build will cease
138 # and the build status will be TIMEOUT.
139 #
140 # Default time is ten minutes.
141 "statusDetail": "A String", # Customer-readable message about the current status.
142 # @OutputOnly
143 "startTime": "A String", # Time at which execution of the build was started.
144 # @OutputOnly
145 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
146 # [Bucket Name
147 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
148 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
149 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
150 # @OutputOnly
151 "images": [ # Images that were built as a part of the build.
152 { # BuiltImage describes an image built by the pipeline.
153 "name": "A String", # Name used to push the container image to Google Container Registry, as
154 # presented to `docker push`.
155 "digest": "A String", # Docker Registry 2.0 digest.
156 },
157 ],
158 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
159 "A String",
160 ],
161 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]162 "createTime": "A String", # Time at which the request to create the build was received.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]163 # @OutputOnly
164 "id": "A String", # Unique identifier of the build.
165 # @OutputOnly
166 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
167 # service.
168 "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
169 # Storage.
170 # Google Cloud Storage.
171 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
172 # omitted, the latest generation will be used.
173 "object": "A String", # Google Cloud Storage object containing source.
174 #
175 # This object must be a gzipped archive file (.tar.gz) containing source to
176 # build.
177 "bucket": "A String", # Google Cloud Storage bucket containing source (see
178 # [Bucket Name
179 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
180 },
181 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
182 # Repository.
183 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
184 # the build is assumed.
185 "branchName": "A String", # Name of the branch to build.
186 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
187 "tagName": "A String", # Name of the tag to build.
188 "commitSha": "A String", # Explicit commit SHA to build.
189 },
190 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]191 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
192 # triggered automatically.
193 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]194 "steps": [ # Describes the operations to be performed on the workspace.
195 { # BuildStep describes a step to perform in the build pipeline.
196 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
197 # This build step will not start until all the build steps in wait_for
198 # have completed successfully. If wait_for is empty, this build step will
199 # start when all previous build steps in the Build.Steps list have completed
200 # successfully.
201 "A String",
202 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]203 "name": "A String", # The name of the container image that will run this particular build step.
204 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]205 # If the image is already available in the host's Docker daemon's cache, it
206 # will be run directly. If not, the host will attempt to pull the image
207 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]208 #
209 # The Docker daemon's cache will already have the latest versions of all of
210 # the officially supported build steps
211 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
212 # will also have cached many of the layers for some popular images, like
213 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
214 # use them.
215 #
216 # If you built an image in a previous build step, it will be stored in the
217 # host's Docker daemon's cache and is available to use as the name for a
218 # later build step.
219 "args": [ # A list of arguments that will be presented to the step when it is started.
220 #
221 # If the image used to run the step's container has an entrypoint, these args
222 # will be used as arguments to that entrypoint. If the image does not define
223 # an entrypoint, the first element in args will be used as the entrypoint,
224 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]225 "A String",
226 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]227 "env": [ # A list of environment variable definitions to be used when running a step.
228 #
229 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
230 # being given the value "VALUE".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]231 "A String",
232 ],
233 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
234 # reference this build step as a dependency.
235 "dir": "A String", # Working directory (relative to project source root) to use when running
236 # this operation's container.
237 },
238 ],
239 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
240 # @OutputOnly
241 # some source was used for this build.
242 "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
243 # revisions resolved.
244 # Repository.
245 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
246 # the build is assumed.
247 "branchName": "A String", # Name of the branch to build.
248 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
249 "tagName": "A String", # Name of the tag to build.
250 "commitSha": "A String", # Explicit commit SHA to build.
251 },
252 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
253 # source integrity was maintained in the build. Note that FileHashes will
254 # only be populated if BuildOptions has requested a SourceProvenanceHash.
255 #
256 # The keys to this map are file paths used as build source and the values
257 # contain the hash values for those files.
258 #
259 # If the build source came in a single package such as a gzipped tarfile
260 # (.tar.gz), the FileHash will be for the single path to that file.
261 # @OutputOnly
262 "a_key": { # Container message for hashes of byte content of files, used in
263 # SourceProvenance messages to verify integrity of source input to the build.
264 "fileHash": [ # Collection of file hashes.
265 { # Container message for hash values.
266 "type": "A String", # The type of hash that was performed.
267 "value": "A String", # The hash value.
268 },
269 ],
270 },
271 },
272 "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
273 # generations resolved.
274 # Google Cloud Storage.
275 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
276 # omitted, the latest generation will be used.
277 "object": "A String", # Google Cloud Storage object containing source.
278 #
279 # This object must be a gzipped archive file (.tar.gz) containing source to
280 # build.
281 "bucket": "A String", # Google Cloud Storage bucket containing source (see
282 # [Bucket Name
283 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
284 },
285 },
286 "projectId": "A String", # ID of the project.
287 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]288 "images": [ # A list of images to be pushed upon the successful completion of all build
289 # steps.
290 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]291 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]292 #
293 # The digests of the pushed images will be stored in the Build resource's
294 # results field.
295 #
296 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]297 "A String",
298 ],
299 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]300 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]301 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
302 "A String",
303 ],
304 },
305 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
306 # @OutputOnly
307 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]308 "id": "A String", # Unique identifier of the trigger.
309 #
310 # @OutputOnly
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]311 "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
312 #
313 # Branch and tag names in trigger templates are interpreted as regular
314 # expressions. Any branch or tag change that matches that regular expression
315 # will trigger a build.
316 # Repository.
317 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
318 # the build is assumed.
319 "branchName": "A String", # Name of the branch to build.
320 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
321 "tagName": "A String", # Name of the tag to build.
322 "commitSha": "A String", # Explicit commit SHA to build.
323 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]324 }
325
326 x__xgafv: string, V1 error format.
327 Allowed values
328 1 - v1 error format
329 2 - v2 error format
330
331Returns:
332 An object of the form:
333
334 { # Configuration for an automated build in response to source repository
335 # changes.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]336 "description": "A String", # Human-readable description of this trigger.
337 "createTime": "A String", # Time when the trigger was created.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]338 #
339 # @OutputOnly
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]340 "filename": "A String", # Path, from the source root, to a file whose contents is used for the
341 # template.
342 "disabled": True or False, # If true, the trigger will never result in a build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]343 "build": { # A build resource in the Container Builder API. # Contents of the build template.
344 #
345 # At a high level, a Build describes where to find source code, how to build
346 # it (for example, the builder image to run on the source), and what tag to
347 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]348 #
349 # Fields can include the following variables which will be expanded when the
350 # build is created:
351 #
352 # - $PROJECT_ID: the project ID of the build.
353 # - $BUILD_ID: the autogenerated ID of the build.
354 # - $REPO_NAME: the source repository name specified by RepoSource.
355 # - $BRANCH_NAME: the branch name specified by RepoSource.
356 # - $TAG_NAME: the tag name specified by RepoSource.
357 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
358 # resolved from the specified branch or tag.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]359 "status": "A String", # Status of the build.
360 # @OutputOnly
361 "finishTime": "A String", # Time at which execution of the build was finished.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]362 #
363 # The difference between finish_time and start_time is the duration of the
364 # build's execution.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]365 # @OutputOnly
366 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
367 # granularity. If this amount of time elapses, work on the build will cease
368 # and the build status will be TIMEOUT.
369 #
370 # Default time is ten minutes.
371 "statusDetail": "A String", # Customer-readable message about the current status.
372 # @OutputOnly
373 "startTime": "A String", # Time at which execution of the build was started.
374 # @OutputOnly
375 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
376 # [Bucket Name
377 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
378 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
379 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
380 # @OutputOnly
381 "images": [ # Images that were built as a part of the build.
382 { # BuiltImage describes an image built by the pipeline.
383 "name": "A String", # Name used to push the container image to Google Container Registry, as
384 # presented to `docker push`.
385 "digest": "A String", # Docker Registry 2.0 digest.
386 },
387 ],
388 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
389 "A String",
390 ],
391 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]392 "createTime": "A String", # Time at which the request to create the build was received.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]393 # @OutputOnly
394 "id": "A String", # Unique identifier of the build.
395 # @OutputOnly
396 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
397 # service.
398 "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
399 # Storage.
400 # Google Cloud Storage.
401 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
402 # omitted, the latest generation will be used.
403 "object": "A String", # Google Cloud Storage object containing source.
404 #
405 # This object must be a gzipped archive file (.tar.gz) containing source to
406 # build.
407 "bucket": "A String", # Google Cloud Storage bucket containing source (see
408 # [Bucket Name
409 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
410 },
411 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
412 # Repository.
413 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
414 # the build is assumed.
415 "branchName": "A String", # Name of the branch to build.
416 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
417 "tagName": "A String", # Name of the tag to build.
418 "commitSha": "A String", # Explicit commit SHA to build.
419 },
420 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]421 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
422 # triggered automatically.
423 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]424 "steps": [ # Describes the operations to be performed on the workspace.
425 { # BuildStep describes a step to perform in the build pipeline.
426 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
427 # This build step will not start until all the build steps in wait_for
428 # have completed successfully. If wait_for is empty, this build step will
429 # start when all previous build steps in the Build.Steps list have completed
430 # successfully.
431 "A String",
432 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]433 "name": "A String", # The name of the container image that will run this particular build step.
434 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]435 # If the image is already available in the host's Docker daemon's cache, it
436 # will be run directly. If not, the host will attempt to pull the image
437 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]438 #
439 # The Docker daemon's cache will already have the latest versions of all of
440 # the officially supported build steps
441 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
442 # will also have cached many of the layers for some popular images, like
443 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
444 # use them.
445 #
446 # If you built an image in a previous build step, it will be stored in the
447 # host's Docker daemon's cache and is available to use as the name for a
448 # later build step.
449 "args": [ # A list of arguments that will be presented to the step when it is started.
450 #
451 # If the image used to run the step's container has an entrypoint, these args
452 # will be used as arguments to that entrypoint. If the image does not define
453 # an entrypoint, the first element in args will be used as the entrypoint,
454 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]455 "A String",
456 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]457 "env": [ # A list of environment variable definitions to be used when running a step.
458 #
459 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
460 # being given the value "VALUE".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]461 "A String",
462 ],
463 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
464 # reference this build step as a dependency.
465 "dir": "A String", # Working directory (relative to project source root) to use when running
466 # this operation's container.
467 },
468 ],
469 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
470 # @OutputOnly
471 # some source was used for this build.
472 "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
473 # revisions resolved.
474 # Repository.
475 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
476 # the build is assumed.
477 "branchName": "A String", # Name of the branch to build.
478 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
479 "tagName": "A String", # Name of the tag to build.
480 "commitSha": "A String", # Explicit commit SHA to build.
481 },
482 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
483 # source integrity was maintained in the build. Note that FileHashes will
484 # only be populated if BuildOptions has requested a SourceProvenanceHash.
485 #
486 # The keys to this map are file paths used as build source and the values
487 # contain the hash values for those files.
488 #
489 # If the build source came in a single package such as a gzipped tarfile
490 # (.tar.gz), the FileHash will be for the single path to that file.
491 # @OutputOnly
492 "a_key": { # Container message for hashes of byte content of files, used in
493 # SourceProvenance messages to verify integrity of source input to the build.
494 "fileHash": [ # Collection of file hashes.
495 { # Container message for hash values.
496 "type": "A String", # The type of hash that was performed.
497 "value": "A String", # The hash value.
498 },
499 ],
500 },
501 },
502 "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
503 # generations resolved.
504 # Google Cloud Storage.
505 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
506 # omitted, the latest generation will be used.
507 "object": "A String", # Google Cloud Storage object containing source.
508 #
509 # This object must be a gzipped archive file (.tar.gz) containing source to
510 # build.
511 "bucket": "A String", # Google Cloud Storage bucket containing source (see
512 # [Bucket Name
513 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
514 },
515 },
516 "projectId": "A String", # ID of the project.
517 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]518 "images": [ # A list of images to be pushed upon the successful completion of all build
519 # steps.
520 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]521 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]522 #
523 # The digests of the pushed images will be stored in the Build resource's
524 # results field.
525 #
526 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]527 "A String",
528 ],
529 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]530 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]531 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
532 "A String",
533 ],
534 },
535 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
536 # @OutputOnly
537 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]538 "id": "A String", # Unique identifier of the trigger.
539 #
540 # @OutputOnly
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]541 "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
542 #
543 # Branch and tag names in trigger templates are interpreted as regular
544 # expressions. Any branch or tag change that matches that regular expression
545 # will trigger a build.
546 # Repository.
547 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
548 # the build is assumed.
549 "branchName": "A String", # Name of the branch to build.
550 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
551 "tagName": "A String", # Name of the tag to build.
552 "commitSha": "A String", # Explicit commit SHA to build.
553 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]554 }</pre>
555</div>
556
557<div class="method">
558 <code class="details" id="delete">delete(projectId, triggerId, x__xgafv=None)</code>
559 <pre>Deletes an BuildTrigger by its project ID and trigger ID.
560
561This API is experimental.
562
563Args:
564 projectId: string, ID of the project that owns the trigger. (required)
565 triggerId: string, ID of the BuildTrigger to delete. (required)
566 x__xgafv: string, V1 error format.
567 Allowed values
568 1 - v1 error format
569 2 - v2 error format
570
571Returns:
572 An object of the form:
573
574 { # A generic empty message that you can re-use to avoid defining duplicated
575 # empty messages in your APIs. A typical example is to use it as the request
576 # or the response type of an API method. For instance:
577 #
578 # service Foo {
579 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
580 # }
581 #
582 # The JSON representation for `Empty` is empty JSON object `{}`.
583 }</pre>
584</div>
585
586<div class="method">
587 <code class="details" id="get">get(projectId, triggerId, x__xgafv=None)</code>
588 <pre>Gets information about a BuildTrigger.
589
590This API is experimental.
591
592Args:
593 projectId: string, ID of the project that owns the trigger. (required)
594 triggerId: string, ID of the BuildTrigger to get. (required)
595 x__xgafv: string, V1 error format.
596 Allowed values
597 1 - v1 error format
598 2 - v2 error format
599
600Returns:
601 An object of the form:
602
603 { # Configuration for an automated build in response to source repository
604 # changes.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]605 "description": "A String", # Human-readable description of this trigger.
606 "createTime": "A String", # Time when the trigger was created.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]607 #
608 # @OutputOnly
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]609 "filename": "A String", # Path, from the source root, to a file whose contents is used for the
610 # template.
611 "disabled": True or False, # If true, the trigger will never result in a build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]612 "build": { # A build resource in the Container Builder API. # Contents of the build template.
613 #
614 # At a high level, a Build describes where to find source code, how to build
615 # it (for example, the builder image to run on the source), and what tag to
616 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]617 #
618 # Fields can include the following variables which will be expanded when the
619 # build is created:
620 #
621 # - $PROJECT_ID: the project ID of the build.
622 # - $BUILD_ID: the autogenerated ID of the build.
623 # - $REPO_NAME: the source repository name specified by RepoSource.
624 # - $BRANCH_NAME: the branch name specified by RepoSource.
625 # - $TAG_NAME: the tag name specified by RepoSource.
626 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
627 # resolved from the specified branch or tag.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]628 "status": "A String", # Status of the build.
629 # @OutputOnly
630 "finishTime": "A String", # Time at which execution of the build was finished.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]631 #
632 # The difference between finish_time and start_time is the duration of the
633 # build's execution.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]634 # @OutputOnly
635 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
636 # granularity. If this amount of time elapses, work on the build will cease
637 # and the build status will be TIMEOUT.
638 #
639 # Default time is ten minutes.
640 "statusDetail": "A String", # Customer-readable message about the current status.
641 # @OutputOnly
642 "startTime": "A String", # Time at which execution of the build was started.
643 # @OutputOnly
644 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
645 # [Bucket Name
646 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
647 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
648 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
649 # @OutputOnly
650 "images": [ # Images that were built as a part of the build.
651 { # BuiltImage describes an image built by the pipeline.
652 "name": "A String", # Name used to push the container image to Google Container Registry, as
653 # presented to `docker push`.
654 "digest": "A String", # Docker Registry 2.0 digest.
655 },
656 ],
657 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
658 "A String",
659 ],
660 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]661 "createTime": "A String", # Time at which the request to create the build was received.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]662 # @OutputOnly
663 "id": "A String", # Unique identifier of the build.
664 # @OutputOnly
665 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
666 # service.
667 "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
668 # Storage.
669 # Google Cloud Storage.
670 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
671 # omitted, the latest generation will be used.
672 "object": "A String", # Google Cloud Storage object containing source.
673 #
674 # This object must be a gzipped archive file (.tar.gz) containing source to
675 # build.
676 "bucket": "A String", # Google Cloud Storage bucket containing source (see
677 # [Bucket Name
678 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
679 },
680 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
681 # Repository.
682 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
683 # the build is assumed.
684 "branchName": "A String", # Name of the branch to build.
685 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
686 "tagName": "A String", # Name of the tag to build.
687 "commitSha": "A String", # Explicit commit SHA to build.
688 },
689 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]690 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
691 # triggered automatically.
692 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]693 "steps": [ # Describes the operations to be performed on the workspace.
694 { # BuildStep describes a step to perform in the build pipeline.
695 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
696 # This build step will not start until all the build steps in wait_for
697 # have completed successfully. If wait_for is empty, this build step will
698 # start when all previous build steps in the Build.Steps list have completed
699 # successfully.
700 "A String",
701 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]702 "name": "A String", # The name of the container image that will run this particular build step.
703 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]704 # If the image is already available in the host's Docker daemon's cache, it
705 # will be run directly. If not, the host will attempt to pull the image
706 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]707 #
708 # The Docker daemon's cache will already have the latest versions of all of
709 # the officially supported build steps
710 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
711 # will also have cached many of the layers for some popular images, like
712 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
713 # use them.
714 #
715 # If you built an image in a previous build step, it will be stored in the
716 # host's Docker daemon's cache and is available to use as the name for a
717 # later build step.
718 "args": [ # A list of arguments that will be presented to the step when it is started.
719 #
720 # If the image used to run the step's container has an entrypoint, these args
721 # will be used as arguments to that entrypoint. If the image does not define
722 # an entrypoint, the first element in args will be used as the entrypoint,
723 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]724 "A String",
725 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]726 "env": [ # A list of environment variable definitions to be used when running a step.
727 #
728 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
729 # being given the value "VALUE".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]730 "A String",
731 ],
732 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
733 # reference this build step as a dependency.
734 "dir": "A String", # Working directory (relative to project source root) to use when running
735 # this operation's container.
736 },
737 ],
738 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
739 # @OutputOnly
740 # some source was used for this build.
741 "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
742 # revisions resolved.
743 # Repository.
744 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
745 # the build is assumed.
746 "branchName": "A String", # Name of the branch to build.
747 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
748 "tagName": "A String", # Name of the tag to build.
749 "commitSha": "A String", # Explicit commit SHA to build.
750 },
751 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
752 # source integrity was maintained in the build. Note that FileHashes will
753 # only be populated if BuildOptions has requested a SourceProvenanceHash.
754 #
755 # The keys to this map are file paths used as build source and the values
756 # contain the hash values for those files.
757 #
758 # If the build source came in a single package such as a gzipped tarfile
759 # (.tar.gz), the FileHash will be for the single path to that file.
760 # @OutputOnly
761 "a_key": { # Container message for hashes of byte content of files, used in
762 # SourceProvenance messages to verify integrity of source input to the build.
763 "fileHash": [ # Collection of file hashes.
764 { # Container message for hash values.
765 "type": "A String", # The type of hash that was performed.
766 "value": "A String", # The hash value.
767 },
768 ],
769 },
770 },
771 "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
772 # generations resolved.
773 # Google Cloud Storage.
774 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
775 # omitted, the latest generation will be used.
776 "object": "A String", # Google Cloud Storage object containing source.
777 #
778 # This object must be a gzipped archive file (.tar.gz) containing source to
779 # build.
780 "bucket": "A String", # Google Cloud Storage bucket containing source (see
781 # [Bucket Name
782 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
783 },
784 },
785 "projectId": "A String", # ID of the project.
786 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]787 "images": [ # A list of images to be pushed upon the successful completion of all build
788 # steps.
789 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]790 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]791 #
792 # The digests of the pushed images will be stored in the Build resource's
793 # results field.
794 #
795 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]796 "A String",
797 ],
798 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]799 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]800 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
801 "A String",
802 ],
803 },
804 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
805 # @OutputOnly
806 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]807 "id": "A String", # Unique identifier of the trigger.
808 #
809 # @OutputOnly
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]810 "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
811 #
812 # Branch and tag names in trigger templates are interpreted as regular
813 # expressions. Any branch or tag change that matches that regular expression
814 # will trigger a build.
815 # Repository.
816 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
817 # the build is assumed.
818 "branchName": "A String", # Name of the branch to build.
819 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
820 "tagName": "A String", # Name of the tag to build.
821 "commitSha": "A String", # Explicit commit SHA to build.
822 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]823 }</pre>
824</div>
825
826<div class="method">
827 <code class="details" id="list">list(projectId, x__xgafv=None)</code>
828 <pre>Lists existing BuildTrigger.
829
830This API is experimental.
831
832Args:
833 projectId: string, ID of the project for which to list BuildTriggers. (required)
834 x__xgafv: string, V1 error format.
835 Allowed values
836 1 - v1 error format
837 2 - v2 error format
838
839Returns:
840 An object of the form:
841
842 { # Response containing existing BuildTriggers.
843 "triggers": [ # BuildTriggers for the project, sorted by create_time descending.
844 { # Configuration for an automated build in response to source repository
845 # changes.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]846 "description": "A String", # Human-readable description of this trigger.
847 "createTime": "A String", # Time when the trigger was created.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]848 #
849 # @OutputOnly
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]850 "filename": "A String", # Path, from the source root, to a file whose contents is used for the
851 # template.
852 "disabled": True or False, # If true, the trigger will never result in a build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]853 "build": { # A build resource in the Container Builder API. # Contents of the build template.
854 #
855 # At a high level, a Build describes where to find source code, how to build
856 # it (for example, the builder image to run on the source), and what tag to
857 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]858 #
859 # Fields can include the following variables which will be expanded when the
860 # build is created:
861 #
862 # - $PROJECT_ID: the project ID of the build.
863 # - $BUILD_ID: the autogenerated ID of the build.
864 # - $REPO_NAME: the source repository name specified by RepoSource.
865 # - $BRANCH_NAME: the branch name specified by RepoSource.
866 # - $TAG_NAME: the tag name specified by RepoSource.
867 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
868 # resolved from the specified branch or tag.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]869 "status": "A String", # Status of the build.
870 # @OutputOnly
871 "finishTime": "A String", # Time at which execution of the build was finished.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]872 #
873 # The difference between finish_time and start_time is the duration of the
874 # build's execution.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]875 # @OutputOnly
876 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
877 # granularity. If this amount of time elapses, work on the build will cease
878 # and the build status will be TIMEOUT.
879 #
880 # Default time is ten minutes.
881 "statusDetail": "A String", # Customer-readable message about the current status.
882 # @OutputOnly
883 "startTime": "A String", # Time at which execution of the build was started.
884 # @OutputOnly
885 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
886 # [Bucket Name
887 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
888 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
889 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
890 # @OutputOnly
891 "images": [ # Images that were built as a part of the build.
892 { # BuiltImage describes an image built by the pipeline.
893 "name": "A String", # Name used to push the container image to Google Container Registry, as
894 # presented to `docker push`.
895 "digest": "A String", # Docker Registry 2.0 digest.
896 },
897 ],
898 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
899 "A String",
900 ],
901 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]902 "createTime": "A String", # Time at which the request to create the build was received.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]903 # @OutputOnly
904 "id": "A String", # Unique identifier of the build.
905 # @OutputOnly
906 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
907 # service.
908 "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
909 # Storage.
910 # Google Cloud Storage.
911 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
912 # omitted, the latest generation will be used.
913 "object": "A String", # Google Cloud Storage object containing source.
914 #
915 # This object must be a gzipped archive file (.tar.gz) containing source to
916 # build.
917 "bucket": "A String", # Google Cloud Storage bucket containing source (see
918 # [Bucket Name
919 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
920 },
921 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
922 # Repository.
923 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
924 # the build is assumed.
925 "branchName": "A String", # Name of the branch to build.
926 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
927 "tagName": "A String", # Name of the tag to build.
928 "commitSha": "A String", # Explicit commit SHA to build.
929 },
930 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]931 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
932 # triggered automatically.
933 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]934 "steps": [ # Describes the operations to be performed on the workspace.
935 { # BuildStep describes a step to perform in the build pipeline.
936 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
937 # This build step will not start until all the build steps in wait_for
938 # have completed successfully. If wait_for is empty, this build step will
939 # start when all previous build steps in the Build.Steps list have completed
940 # successfully.
941 "A String",
942 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]943 "name": "A String", # The name of the container image that will run this particular build step.
944 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]945 # If the image is already available in the host's Docker daemon's cache, it
946 # will be run directly. If not, the host will attempt to pull the image
947 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]948 #
949 # The Docker daemon's cache will already have the latest versions of all of
950 # the officially supported build steps
951 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
952 # will also have cached many of the layers for some popular images, like
953 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
954 # use them.
955 #
956 # If you built an image in a previous build step, it will be stored in the
957 # host's Docker daemon's cache and is available to use as the name for a
958 # later build step.
959 "args": [ # A list of arguments that will be presented to the step when it is started.
960 #
961 # If the image used to run the step's container has an entrypoint, these args
962 # will be used as arguments to that entrypoint. If the image does not define
963 # an entrypoint, the first element in args will be used as the entrypoint,
964 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]965 "A String",
966 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]967 "env": [ # A list of environment variable definitions to be used when running a step.
968 #
969 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
970 # being given the value "VALUE".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]971 "A String",
972 ],
973 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
974 # reference this build step as a dependency.
975 "dir": "A String", # Working directory (relative to project source root) to use when running
976 # this operation's container.
977 },
978 ],
979 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
980 # @OutputOnly
981 # some source was used for this build.
982 "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
983 # revisions resolved.
984 # Repository.
985 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
986 # the build is assumed.
987 "branchName": "A String", # Name of the branch to build.
988 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
989 "tagName": "A String", # Name of the tag to build.
990 "commitSha": "A String", # Explicit commit SHA to build.
991 },
992 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
993 # source integrity was maintained in the build. Note that FileHashes will
994 # only be populated if BuildOptions has requested a SourceProvenanceHash.
995 #
996 # The keys to this map are file paths used as build source and the values
997 # contain the hash values for those files.
998 #
999 # If the build source came in a single package such as a gzipped tarfile
1000 # (.tar.gz), the FileHash will be for the single path to that file.
1001 # @OutputOnly
1002 "a_key": { # Container message for hashes of byte content of files, used in
1003 # SourceProvenance messages to verify integrity of source input to the build.
1004 "fileHash": [ # Collection of file hashes.
1005 { # Container message for hash values.
1006 "type": "A String", # The type of hash that was performed.
1007 "value": "A String", # The hash value.
1008 },
1009 ],
1010 },
1011 },
1012 "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
1013 # generations resolved.
1014 # Google Cloud Storage.
1015 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1016 # omitted, the latest generation will be used.
1017 "object": "A String", # Google Cloud Storage object containing source.
1018 #
1019 # This object must be a gzipped archive file (.tar.gz) containing source to
1020 # build.
1021 "bucket": "A String", # Google Cloud Storage bucket containing source (see
1022 # [Bucket Name
1023 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1024 },
1025 },
1026 "projectId": "A String", # ID of the project.
1027 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1028 "images": [ # A list of images to be pushed upon the successful completion of all build
1029 # steps.
1030 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1031 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1032 #
1033 # The digests of the pushed images will be stored in the Build resource's
1034 # results field.
1035 #
1036 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1037 "A String",
1038 ],
1039 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1040 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1041 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
1042 "A String",
1043 ],
1044 },
1045 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
1046 # @OutputOnly
1047 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1048 "id": "A String", # Unique identifier of the trigger.
1049 #
1050 # @OutputOnly
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]1051 "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
1052 #
1053 # Branch and tag names in trigger templates are interpreted as regular
1054 # expressions. Any branch or tag change that matches that regular expression
1055 # will trigger a build.
1056 # Repository.
1057 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
1058 # the build is assumed.
1059 "branchName": "A String", # Name of the branch to build.
1060 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
1061 "tagName": "A String", # Name of the tag to build.
1062 "commitSha": "A String", # Explicit commit SHA to build.
1063 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1064 },
1065 ],
1066 }</pre>
1067</div>
1068
1069<div class="method">
1070 <code class="details" id="patch">patch(projectId, triggerId, body, x__xgafv=None)</code>
1071 <pre>Updates an BuildTrigger by its project ID and trigger ID.
1072
1073This API is experimental.
1074
1075Args:
1076 projectId: string, ID of the project that owns the trigger. (required)
1077 triggerId: string, ID of the BuildTrigger to update. (required)
1078 body: object, The request body. (required)
1079 The object takes the form of:
1080
1081{ # Configuration for an automated build in response to source repository
1082 # changes.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1083 "description": "A String", # Human-readable description of this trigger.
1084 "createTime": "A String", # Time when the trigger was created.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1085 #
1086 # @OutputOnly
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1087 "filename": "A String", # Path, from the source root, to a file whose contents is used for the
1088 # template.
1089 "disabled": True or False, # If true, the trigger will never result in a build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1090 "build": { # A build resource in the Container Builder API. # Contents of the build template.
1091 #
1092 # At a high level, a Build describes where to find source code, how to build
1093 # it (for example, the builder image to run on the source), and what tag to
1094 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1095 #
1096 # Fields can include the following variables which will be expanded when the
1097 # build is created:
1098 #
1099 # - $PROJECT_ID: the project ID of the build.
1100 # - $BUILD_ID: the autogenerated ID of the build.
1101 # - $REPO_NAME: the source repository name specified by RepoSource.
1102 # - $BRANCH_NAME: the branch name specified by RepoSource.
1103 # - $TAG_NAME: the tag name specified by RepoSource.
1104 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
1105 # resolved from the specified branch or tag.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1106 "status": "A String", # Status of the build.
1107 # @OutputOnly
1108 "finishTime": "A String", # Time at which execution of the build was finished.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1109 #
1110 # The difference between finish_time and start_time is the duration of the
1111 # build's execution.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1112 # @OutputOnly
1113 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
1114 # granularity. If this amount of time elapses, work on the build will cease
1115 # and the build status will be TIMEOUT.
1116 #
1117 # Default time is ten minutes.
1118 "statusDetail": "A String", # Customer-readable message about the current status.
1119 # @OutputOnly
1120 "startTime": "A String", # Time at which execution of the build was started.
1121 # @OutputOnly
1122 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
1123 # [Bucket Name
1124 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1125 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
1126 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
1127 # @OutputOnly
1128 "images": [ # Images that were built as a part of the build.
1129 { # BuiltImage describes an image built by the pipeline.
1130 "name": "A String", # Name used to push the container image to Google Container Registry, as
1131 # presented to `docker push`.
1132 "digest": "A String", # Docker Registry 2.0 digest.
1133 },
1134 ],
1135 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
1136 "A String",
1137 ],
1138 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1139 "createTime": "A String", # Time at which the request to create the build was received.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1140 # @OutputOnly
1141 "id": "A String", # Unique identifier of the build.
1142 # @OutputOnly
1143 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
1144 # service.
1145 "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
1146 # Storage.
1147 # Google Cloud Storage.
1148 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1149 # omitted, the latest generation will be used.
1150 "object": "A String", # Google Cloud Storage object containing source.
1151 #
1152 # This object must be a gzipped archive file (.tar.gz) containing source to
1153 # build.
1154 "bucket": "A String", # Google Cloud Storage bucket containing source (see
1155 # [Bucket Name
1156 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1157 },
1158 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
1159 # Repository.
1160 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
1161 # the build is assumed.
1162 "branchName": "A String", # Name of the branch to build.
1163 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
1164 "tagName": "A String", # Name of the tag to build.
1165 "commitSha": "A String", # Explicit commit SHA to build.
1166 },
1167 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1168 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
1169 # triggered automatically.
1170 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1171 "steps": [ # Describes the operations to be performed on the workspace.
1172 { # BuildStep describes a step to perform in the build pipeline.
1173 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
1174 # This build step will not start until all the build steps in wait_for
1175 # have completed successfully. If wait_for is empty, this build step will
1176 # start when all previous build steps in the Build.Steps list have completed
1177 # successfully.
1178 "A String",
1179 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1180 "name": "A String", # The name of the container image that will run this particular build step.
1181 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1182 # If the image is already available in the host's Docker daemon's cache, it
1183 # will be run directly. If not, the host will attempt to pull the image
1184 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1185 #
1186 # The Docker daemon's cache will already have the latest versions of all of
1187 # the officially supported build steps
1188 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
1189 # will also have cached many of the layers for some popular images, like
1190 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
1191 # use them.
1192 #
1193 # If you built an image in a previous build step, it will be stored in the
1194 # host's Docker daemon's cache and is available to use as the name for a
1195 # later build step.
1196 "args": [ # A list of arguments that will be presented to the step when it is started.
1197 #
1198 # If the image used to run the step's container has an entrypoint, these args
1199 # will be used as arguments to that entrypoint. If the image does not define
1200 # an entrypoint, the first element in args will be used as the entrypoint,
1201 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1202 "A String",
1203 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1204 "env": [ # A list of environment variable definitions to be used when running a step.
1205 #
1206 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
1207 # being given the value "VALUE".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1208 "A String",
1209 ],
1210 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
1211 # reference this build step as a dependency.
1212 "dir": "A String", # Working directory (relative to project source root) to use when running
1213 # this operation's container.
1214 },
1215 ],
1216 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
1217 # @OutputOnly
1218 # some source was used for this build.
1219 "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
1220 # revisions resolved.
1221 # Repository.
1222 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
1223 # the build is assumed.
1224 "branchName": "A String", # Name of the branch to build.
1225 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
1226 "tagName": "A String", # Name of the tag to build.
1227 "commitSha": "A String", # Explicit commit SHA to build.
1228 },
1229 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
1230 # source integrity was maintained in the build. Note that FileHashes will
1231 # only be populated if BuildOptions has requested a SourceProvenanceHash.
1232 #
1233 # The keys to this map are file paths used as build source and the values
1234 # contain the hash values for those files.
1235 #
1236 # If the build source came in a single package such as a gzipped tarfile
1237 # (.tar.gz), the FileHash will be for the single path to that file.
1238 # @OutputOnly
1239 "a_key": { # Container message for hashes of byte content of files, used in
1240 # SourceProvenance messages to verify integrity of source input to the build.
1241 "fileHash": [ # Collection of file hashes.
1242 { # Container message for hash values.
1243 "type": "A String", # The type of hash that was performed.
1244 "value": "A String", # The hash value.
1245 },
1246 ],
1247 },
1248 },
1249 "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
1250 # generations resolved.
1251 # Google Cloud Storage.
1252 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1253 # omitted, the latest generation will be used.
1254 "object": "A String", # Google Cloud Storage object containing source.
1255 #
1256 # This object must be a gzipped archive file (.tar.gz) containing source to
1257 # build.
1258 "bucket": "A String", # Google Cloud Storage bucket containing source (see
1259 # [Bucket Name
1260 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1261 },
1262 },
1263 "projectId": "A String", # ID of the project.
1264 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1265 "images": [ # A list of images to be pushed upon the successful completion of all build
1266 # steps.
1267 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1268 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1269 #
1270 # The digests of the pushed images will be stored in the Build resource's
1271 # results field.
1272 #
1273 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1274 "A String",
1275 ],
1276 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1277 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1278 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
1279 "A String",
1280 ],
1281 },
1282 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
1283 # @OutputOnly
1284 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1285 "id": "A String", # Unique identifier of the trigger.
1286 #
1287 # @OutputOnly
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]1288 "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
1289 #
1290 # Branch and tag names in trigger templates are interpreted as regular
1291 # expressions. Any branch or tag change that matches that regular expression
1292 # will trigger a build.
1293 # Repository.
1294 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
1295 # the build is assumed.
1296 "branchName": "A String", # Name of the branch to build.
1297 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
1298 "tagName": "A String", # Name of the tag to build.
1299 "commitSha": "A String", # Explicit commit SHA to build.
1300 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1301 }
1302
1303 x__xgafv: string, V1 error format.
1304 Allowed values
1305 1 - v1 error format
1306 2 - v2 error format
1307
1308Returns:
1309 An object of the form:
1310
1311 { # Configuration for an automated build in response to source repository
1312 # changes.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1313 "description": "A String", # Human-readable description of this trigger.
1314 "createTime": "A String", # Time when the trigger was created.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1315 #
1316 # @OutputOnly
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1317 "filename": "A String", # Path, from the source root, to a file whose contents is used for the
1318 # template.
1319 "disabled": True or False, # If true, the trigger will never result in a build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1320 "build": { # A build resource in the Container Builder API. # Contents of the build template.
1321 #
1322 # At a high level, a Build describes where to find source code, how to build
1323 # it (for example, the builder image to run on the source), and what tag to
1324 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1325 #
1326 # Fields can include the following variables which will be expanded when the
1327 # build is created:
1328 #
1329 # - $PROJECT_ID: the project ID of the build.
1330 # - $BUILD_ID: the autogenerated ID of the build.
1331 # - $REPO_NAME: the source repository name specified by RepoSource.
1332 # - $BRANCH_NAME: the branch name specified by RepoSource.
1333 # - $TAG_NAME: the tag name specified by RepoSource.
1334 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
1335 # resolved from the specified branch or tag.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1336 "status": "A String", # Status of the build.
1337 # @OutputOnly
1338 "finishTime": "A String", # Time at which execution of the build was finished.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1339 #
1340 # The difference between finish_time and start_time is the duration of the
1341 # build's execution.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1342 # @OutputOnly
1343 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
1344 # granularity. If this amount of time elapses, work on the build will cease
1345 # and the build status will be TIMEOUT.
1346 #
1347 # Default time is ten minutes.
1348 "statusDetail": "A String", # Customer-readable message about the current status.
1349 # @OutputOnly
1350 "startTime": "A String", # Time at which execution of the build was started.
1351 # @OutputOnly
1352 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
1353 # [Bucket Name
1354 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1355 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
1356 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
1357 # @OutputOnly
1358 "images": [ # Images that were built as a part of the build.
1359 { # BuiltImage describes an image built by the pipeline.
1360 "name": "A String", # Name used to push the container image to Google Container Registry, as
1361 # presented to `docker push`.
1362 "digest": "A String", # Docker Registry 2.0 digest.
1363 },
1364 ],
1365 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
1366 "A String",
1367 ],
1368 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1369 "createTime": "A String", # Time at which the request to create the build was received.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1370 # @OutputOnly
1371 "id": "A String", # Unique identifier of the build.
1372 # @OutputOnly
1373 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
1374 # service.
1375 "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
1376 # Storage.
1377 # Google Cloud Storage.
1378 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1379 # omitted, the latest generation will be used.
1380 "object": "A String", # Google Cloud Storage object containing source.
1381 #
1382 # This object must be a gzipped archive file (.tar.gz) containing source to
1383 # build.
1384 "bucket": "A String", # Google Cloud Storage bucket containing source (see
1385 # [Bucket Name
1386 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1387 },
1388 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
1389 # Repository.
1390 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
1391 # the build is assumed.
1392 "branchName": "A String", # Name of the branch to build.
1393 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
1394 "tagName": "A String", # Name of the tag to build.
1395 "commitSha": "A String", # Explicit commit SHA to build.
1396 },
1397 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1398 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
1399 # triggered automatically.
1400 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1401 "steps": [ # Describes the operations to be performed on the workspace.
1402 { # BuildStep describes a step to perform in the build pipeline.
1403 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
1404 # This build step will not start until all the build steps in wait_for
1405 # have completed successfully. If wait_for is empty, this build step will
1406 # start when all previous build steps in the Build.Steps list have completed
1407 # successfully.
1408 "A String",
1409 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1410 "name": "A String", # The name of the container image that will run this particular build step.
1411 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1412 # If the image is already available in the host's Docker daemon's cache, it
1413 # will be run directly. If not, the host will attempt to pull the image
1414 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1415 #
1416 # The Docker daemon's cache will already have the latest versions of all of
1417 # the officially supported build steps
1418 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
1419 # will also have cached many of the layers for some popular images, like
1420 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
1421 # use them.
1422 #
1423 # If you built an image in a previous build step, it will be stored in the
1424 # host's Docker daemon's cache and is available to use as the name for a
1425 # later build step.
1426 "args": [ # A list of arguments that will be presented to the step when it is started.
1427 #
1428 # If the image used to run the step's container has an entrypoint, these args
1429 # will be used as arguments to that entrypoint. If the image does not define
1430 # an entrypoint, the first element in args will be used as the entrypoint,
1431 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1432 "A String",
1433 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1434 "env": [ # A list of environment variable definitions to be used when running a step.
1435 #
1436 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
1437 # being given the value "VALUE".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1438 "A String",
1439 ],
1440 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
1441 # reference this build step as a dependency.
1442 "dir": "A String", # Working directory (relative to project source root) to use when running
1443 # this operation's container.
1444 },
1445 ],
1446 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
1447 # @OutputOnly
1448 # some source was used for this build.
1449 "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
1450 # revisions resolved.
1451 # Repository.
1452 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
1453 # the build is assumed.
1454 "branchName": "A String", # Name of the branch to build.
1455 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
1456 "tagName": "A String", # Name of the tag to build.
1457 "commitSha": "A String", # Explicit commit SHA to build.
1458 },
1459 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
1460 # source integrity was maintained in the build. Note that FileHashes will
1461 # only be populated if BuildOptions has requested a SourceProvenanceHash.
1462 #
1463 # The keys to this map are file paths used as build source and the values
1464 # contain the hash values for those files.
1465 #
1466 # If the build source came in a single package such as a gzipped tarfile
1467 # (.tar.gz), the FileHash will be for the single path to that file.
1468 # @OutputOnly
1469 "a_key": { # Container message for hashes of byte content of files, used in
1470 # SourceProvenance messages to verify integrity of source input to the build.
1471 "fileHash": [ # Collection of file hashes.
1472 { # Container message for hash values.
1473 "type": "A String", # The type of hash that was performed.
1474 "value": "A String", # The hash value.
1475 },
1476 ],
1477 },
1478 },
1479 "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
1480 # generations resolved.
1481 # Google Cloud Storage.
1482 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1483 # omitted, the latest generation will be used.
1484 "object": "A String", # Google Cloud Storage object containing source.
1485 #
1486 # This object must be a gzipped archive file (.tar.gz) containing source to
1487 # build.
1488 "bucket": "A String", # Google Cloud Storage bucket containing source (see
1489 # [Bucket Name
1490 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1491 },
1492 },
1493 "projectId": "A String", # ID of the project.
1494 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1495 "images": [ # A list of images to be pushed upon the successful completion of all build
1496 # steps.
1497 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1498 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1499 #
1500 # The digests of the pushed images will be stored in the Build resource's
1501 # results field.
1502 #
1503 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1504 "A String",
1505 ],
1506 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1507 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1508 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
1509 "A String",
1510 ],
1511 },
1512 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
1513 # @OutputOnly
1514 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1515 "id": "A String", # Unique identifier of the trigger.
1516 #
1517 # @OutputOnly
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]1518 "triggerTemplate": { # RepoSource describes the location of the source in a Google Cloud Source # Template describing the types of source changes to trigger a build.
1519 #
1520 # Branch and tag names in trigger templates are interpreted as regular
1521 # expressions. Any branch or tag change that matches that regular expression
1522 # will trigger a build.
1523 # Repository.
1524 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
1525 # the build is assumed.
1526 "branchName": "A String", # Name of the branch to build.
1527 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
1528 "tagName": "A String", # Name of the tag to build.
1529 "commitSha": "A String", # Explicit commit SHA to build.
1530 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1531 }</pre>
1532</div>
1533
1534</body></html>