Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ea3a5e1b5572e5438ba86ec0074f60029bd94855 / . / docs / dyn / cloudbuild_v1.projects.builds.html
blob: 1ab68eb3bf9b52589313c04accc0d3387ec36411 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -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.builds.html">builds</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(projectId, id, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Cancels a requested build in progress.</p>
80<p class="toc_element">
81 <code><a href="#create">create(projectId, body, x__xgafv=None)</a></code></p>
82<p class="firstline">Starts a build with the specified configuration.</p>
83<p class="toc_element">
84 <code><a href="#get">get(projectId, id, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns information about a previously requested build.</p>
86<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]87 <code><a href="#list">list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]88<p class="firstline">Lists previously requested builds.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="cancel">cancel(projectId, id, body, x__xgafv=None)</code>
95 <pre>Cancels a requested build in progress.
96
97Args:
98 projectId: string, ID of the project. (required)
99 id: string, ID of the build. (required)
100 body: object, The request body. (required)
101 The object takes the form of:
102
103{ # Request to cancel an ongoing build.
104 }
105
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
114 { # A build resource in the Container Builder API.
115 #
116 # At a high level, a Build describes where to find source code, how to build
117 # it (for example, the builder image to run on the source), and what tag to
118 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]119 #
120 # Fields can include the following variables which will be expanded when the
121 # build is created:
122 #
123 # - $PROJECT_ID: the project ID of the build.
124 # - $BUILD_ID: the autogenerated ID of the build.
125 # - $REPO_NAME: the source repository name specified by RepoSource.
126 # - $BRANCH_NAME: the branch name specified by RepoSource.
127 # - $TAG_NAME: the tag name specified by RepoSource.
128 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
129 # resolved from the specified branch or tag.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]130 "status": "A String", # Status of the build.
131 # @OutputOnly
132 "finishTime": "A String", # Time at which execution of the build was finished.
133 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]134 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
135 # granularity. If this amount of time elapses, work on the build will cease
136 # and the build status will be TIMEOUT.
137 #
138 # Default time is ten minutes.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]139 "statusDetail": "A String", # Customer-readable message about the current status.
140 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]141 "startTime": "A String", # Time at which execution of the build was started.
142 # @OutputOnly
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]143 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
144 # [Bucket Name
145 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
146 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
147 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
148 # @OutputOnly
149 "images": [ # Images that were built as a part of the build.
150 { # BuiltImage describes an image built by the pipeline.
151 "name": "A String", # Name used to push the container image to Google Container Registry, as
152 # presented to `docker push`.
153 "digest": "A String", # Docker Registry 2.0 digest.
154 },
155 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]156 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
157 "A String",
158 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]159 },
160 "createTime": "A String", # Time at which the build was created.
161 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]162 "id": "A String", # Unique identifier of the build.
163 # @OutputOnly
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]164 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
165 # service.
166 "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
167 # Storage.
168 # Google Cloud Storage.
169 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
170 # omitted, the latest generation will be used.
171 "object": "A String", # Google Cloud Storage object containing source.
172 #
173 # This object must be a gzipped archive file (.tar.gz) containing source to
174 # build.
175 "bucket": "A String", # Google Cloud Storage bucket containing source (see
176 # [Bucket Name
177 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
178 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]179 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
180 # Repository.
181 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
182 # the build is assumed.
183 "branchName": "A String", # Name of the branch to build.
184 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
185 "tagName": "A String", # Name of the tag to build.
186 "commitSha": "A String", # Explicit commit SHA to build.
187 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]188 },
189 "steps": [ # Describes the operations to be performed on the workspace.
190 { # BuildStep describes a step to perform in the build pipeline.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]191 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
192 # This build step will not start until all the build steps in wait_for
193 # have completed successfully. If wait_for is empty, this build step will
194 # start when all previous build steps in the Build.Steps list have completed
195 # successfully.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]196 "A String",
197 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]198 "name": "A String", # The name of the container image that will run this particular build step.
199 #
200 # If the image is already available in the host's
201 # Docker daemon's cache, it will be run directly. If not, the host will
202 # attempt to pull the image first, using the builder service account's
203 # credentials if necessary.
204 #
205 # The Docker daemon's cache will already have the latest versions of all of
206 # the officially supported build steps
207 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
208 # will also have cached many of the layers for some popular images, like
209 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
210 # use them.
211 #
212 # If you built an image in a previous build step, it will be stored in the
213 # host's Docker daemon's cache and is available to use as the name for a
214 # later build step.
215 "args": [ # A list of arguments that will be presented to the step when it is started.
216 #
217 # If the image used to run the step's container has an entrypoint, these args
218 # will be used as arguments to that entrypoint. If the image does not define
219 # an entrypoint, the first element in args will be used as the entrypoint,
220 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]221 "A String",
222 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]223 "env": [ # A list of environment variable definitions to be used when running a step.
224 #
225 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
226 # being given the value "VALUE".
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]227 "A String",
228 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]229 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
230 # reference this build step as a dependency.
231 "dir": "A String", # Working directory (relative to project source root) to use when running
232 # this operation's container.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]233 },
234 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]235 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
236 # @OutputOnly
237 # some source was used for this build.
238 "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
239 # revisions resolved.
240 # Repository.
241 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
242 # the build is assumed.
243 "branchName": "A String", # Name of the branch to build.
244 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
245 "tagName": "A String", # Name of the tag to build.
246 "commitSha": "A String", # Explicit commit SHA to build.
247 },
248 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
249 # source integrity was maintained in the build. Note that FileHashes will
250 # only be populated if BuildOptions has requested a SourceProvenanceHash.
251 #
252 # The keys to this map are file paths used as build source and the values
253 # contain the hash values for those files.
254 #
255 # If the build source came in a single package such as a gzipped tarfile
256 # (.tar.gz), the FileHash will be for the single path to that file.
257 # @OutputOnly
258 "a_key": { # Container message for hashes of byte content of files, used in
259 # SourceProvenance messages to verify integrity of source input to the build.
260 "fileHash": [ # Collection of file hashes.
261 { # Container message for hash values.
262 "type": "A String", # The type of hash that was performed.
263 "value": "A String", # The hash value.
264 },
265 ],
266 },
267 },
268 "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
269 # generations resolved.
270 # Google Cloud Storage.
271 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
272 # omitted, the latest generation will be used.
273 "object": "A String", # Google Cloud Storage object containing source.
274 #
275 # This object must be a gzipped archive file (.tar.gz) containing source to
276 # build.
277 "bucket": "A String", # Google Cloud Storage bucket containing source (see
278 # [Bucket Name
279 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
280 },
281 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]282 "projectId": "A String", # ID of the project.
283 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]284 "images": [ # A list of images to be pushed upon the successful completion of all build
285 # steps.
286 #
287 # The images will be pushed using the builder
288 # service account's credentials.
289 #
290 # The digests of the pushed images will be stored in the Build resource's
291 # results field.
292 #
293 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]294 "A String",
295 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]296 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]297 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]298 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
299 "A String",
300 ],
301 },
302 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]303 # @OutputOnly
304 }</pre>
305</div>
306
307<div class="method">
308 <code class="details" id="create">create(projectId, body, x__xgafv=None)</code>
309 <pre>Starts a build with the specified configuration.
310
311The long-running Operation returned by this method will include the ID of
312the build, which can be passed to GetBuild to determine its status (e.g.,
313success or failure).
314
315Args:
316 projectId: string, ID of the project. (required)
317 body: object, The request body. (required)
318 The object takes the form of:
319
320{ # A build resource in the Container Builder API.
321 #
322 # At a high level, a Build describes where to find source code, how to build
323 # it (for example, the builder image to run on the source), and what tag to
324 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]325 #
326 # Fields can include the following variables which will be expanded when the
327 # build is created:
328 #
329 # - $PROJECT_ID: the project ID of the build.
330 # - $BUILD_ID: the autogenerated ID of the build.
331 # - $REPO_NAME: the source repository name specified by RepoSource.
332 # - $BRANCH_NAME: the branch name specified by RepoSource.
333 # - $TAG_NAME: the tag name specified by RepoSource.
334 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
335 # resolved from the specified branch or tag.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]336 "status": "A String", # Status of the build.
337 # @OutputOnly
338 "finishTime": "A String", # Time at which execution of the build was finished.
339 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]340 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
341 # granularity. If this amount of time elapses, work on the build will cease
342 # and the build status will be TIMEOUT.
343 #
344 # Default time is ten minutes.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]345 "statusDetail": "A String", # Customer-readable message about the current status.
346 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]347 "startTime": "A String", # Time at which execution of the build was started.
348 # @OutputOnly
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]349 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
350 # [Bucket Name
351 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
352 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
353 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
354 # @OutputOnly
355 "images": [ # Images that were built as a part of the build.
356 { # BuiltImage describes an image built by the pipeline.
357 "name": "A String", # Name used to push the container image to Google Container Registry, as
358 # presented to `docker push`.
359 "digest": "A String", # Docker Registry 2.0 digest.
360 },
361 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]362 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
363 "A String",
364 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]365 },
366 "createTime": "A String", # Time at which the build was created.
367 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]368 "id": "A String", # Unique identifier of the build.
369 # @OutputOnly
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]370 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
371 # service.
372 "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
373 # Storage.
374 # Google Cloud Storage.
375 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
376 # omitted, the latest generation will be used.
377 "object": "A String", # Google Cloud Storage object containing source.
378 #
379 # This object must be a gzipped archive file (.tar.gz) containing source to
380 # build.
381 "bucket": "A String", # Google Cloud Storage bucket containing source (see
382 # [Bucket Name
383 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
384 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]385 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
386 # Repository.
387 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
388 # the build is assumed.
389 "branchName": "A String", # Name of the branch to build.
390 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
391 "tagName": "A String", # Name of the tag to build.
392 "commitSha": "A String", # Explicit commit SHA to build.
393 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]394 },
395 "steps": [ # Describes the operations to be performed on the workspace.
396 { # BuildStep describes a step to perform in the build pipeline.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]397 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
398 # This build step will not start until all the build steps in wait_for
399 # have completed successfully. If wait_for is empty, this build step will
400 # start when all previous build steps in the Build.Steps list have completed
401 # successfully.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]402 "A String",
403 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]404 "name": "A String", # The name of the container image that will run this particular build step.
405 #
406 # If the image is already available in the host's
407 # Docker daemon's cache, it will be run directly. If not, the host will
408 # attempt to pull the image first, using the builder service account's
409 # credentials if necessary.
410 #
411 # The Docker daemon's cache will already have the latest versions of all of
412 # the officially supported build steps
413 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
414 # will also have cached many of the layers for some popular images, like
415 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
416 # use them.
417 #
418 # If you built an image in a previous build step, it will be stored in the
419 # host's Docker daemon's cache and is available to use as the name for a
420 # later build step.
421 "args": [ # A list of arguments that will be presented to the step when it is started.
422 #
423 # If the image used to run the step's container has an entrypoint, these args
424 # will be used as arguments to that entrypoint. If the image does not define
425 # an entrypoint, the first element in args will be used as the entrypoint,
426 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]427 "A String",
428 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]429 "env": [ # A list of environment variable definitions to be used when running a step.
430 #
431 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
432 # being given the value "VALUE".
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]433 "A String",
434 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]435 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
436 # reference this build step as a dependency.
437 "dir": "A String", # Working directory (relative to project source root) to use when running
438 # this operation's container.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]439 },
440 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]441 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
442 # @OutputOnly
443 # some source was used for this build.
444 "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
445 # revisions resolved.
446 # Repository.
447 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
448 # the build is assumed.
449 "branchName": "A String", # Name of the branch to build.
450 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
451 "tagName": "A String", # Name of the tag to build.
452 "commitSha": "A String", # Explicit commit SHA to build.
453 },
454 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
455 # source integrity was maintained in the build. Note that FileHashes will
456 # only be populated if BuildOptions has requested a SourceProvenanceHash.
457 #
458 # The keys to this map are file paths used as build source and the values
459 # contain the hash values for those files.
460 #
461 # If the build source came in a single package such as a gzipped tarfile
462 # (.tar.gz), the FileHash will be for the single path to that file.
463 # @OutputOnly
464 "a_key": { # Container message for hashes of byte content of files, used in
465 # SourceProvenance messages to verify integrity of source input to the build.
466 "fileHash": [ # Collection of file hashes.
467 { # Container message for hash values.
468 "type": "A String", # The type of hash that was performed.
469 "value": "A String", # The hash value.
470 },
471 ],
472 },
473 },
474 "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
475 # generations resolved.
476 # Google Cloud Storage.
477 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
478 # omitted, the latest generation will be used.
479 "object": "A String", # Google Cloud Storage object containing source.
480 #
481 # This object must be a gzipped archive file (.tar.gz) containing source to
482 # build.
483 "bucket": "A String", # Google Cloud Storage bucket containing source (see
484 # [Bucket Name
485 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
486 },
487 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]488 "projectId": "A String", # ID of the project.
489 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]490 "images": [ # A list of images to be pushed upon the successful completion of all build
491 # steps.
492 #
493 # The images will be pushed using the builder
494 # service account's credentials.
495 #
496 # The digests of the pushed images will be stored in the Build resource's
497 # results field.
498 #
499 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]500 "A String",
501 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]502 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]503 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]504 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
505 "A String",
506 ],
507 },
508 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]509 # @OutputOnly
510}
511
512 x__xgafv: string, V1 error format.
513 Allowed values
514 1 - v1 error format
515 2 - v2 error format
516
517Returns:
518 An object of the form:
519
520 { # This resource represents a long-running operation that is the result of a
521 # network API call.
522 "metadata": { # Service-specific metadata associated with the operation. It typically
523 # contains progress information and common metadata such as create time.
524 # Some services might not provide such metadata. Any method that returns a
525 # long-running operation should document the metadata type, if any.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]526 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]527 },
528 "done": True or False, # If the value is `false`, it means the operation is still in progress.
529 # If true, the operation is completed, and either `error` or `response` is
530 # available.
531 "response": { # The normal response of the operation in case of success. If the original
532 # method returns no data on success, such as `Delete`, the response is
533 # `google.protobuf.Empty`. If the original method is standard
534 # `Get`/`Create`/`Update`, the response should be the resource. For other
535 # methods, the response should have the type `XxxResponse`, where `Xxx`
536 # is the original method name. For example, if the original method name
537 # is `TakeSnapshot()`, the inferred response type is
538 # `TakeSnapshotResponse`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]539 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]540 },
541 "name": "A String", # The server-assigned name, which is only unique within the same service that
542 # originally returns it. If you use the default HTTP mapping, the
543 # `name` should have the format of `operations/some/unique/name`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]544 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]545 # programming environments, including REST APIs and RPC APIs. It is used by
546 # [gRPC](https://github.com/grpc). The error model is designed to be:
547 #
548 # - Simple to use and understand for most users
549 # - Flexible enough to meet unexpected needs
550 #
551 # # Overview
552 #
553 # The `Status` message contains three pieces of data: error code, error message,
554 # and error details. The error code should be an enum value of
555 # google.rpc.Code, but it may accept additional error codes if needed. The
556 # error message should be a developer-facing English message that helps
557 # developers *understand* and *resolve* the error. If a localized user-facing
558 # error message is needed, put the localized message in the error details or
559 # localize it in the client. The optional error details may contain arbitrary
560 # information about the error. There is a predefined set of error detail types
561 # in the package `google.rpc` which can be used for common error conditions.
562 #
563 # # Language mapping
564 #
565 # The `Status` message is the logical representation of the error model, but it
566 # is not necessarily the actual wire format. When the `Status` message is
567 # exposed in different client libraries and different wire protocols, it can be
568 # mapped differently. For example, it will likely be mapped to some exceptions
569 # in Java, but more likely mapped to some error codes in C.
570 #
571 # # Other uses
572 #
573 # The error model and the `Status` message can be used in a variety of
574 # environments, either with or without APIs, to provide a
575 # consistent developer experience across different environments.
576 #
577 # Example uses of this error model include:
578 #
579 # - Partial errors. If a service needs to return partial errors to the client,
580 # it may embed the `Status` in the normal response to indicate the partial
581 # errors.
582 #
583 # - Workflow errors. A typical workflow has multiple steps. Each step may
584 # have a `Status` message for error reporting purpose.
585 #
586 # - Batch operations. If a client uses batch request and batch response, the
587 # `Status` message should be used directly inside batch response, one for
588 # each error sub-response.
589 #
590 # - Asynchronous operations. If an API call embeds asynchronous operation
591 # results in its response, the status of those operations should be
592 # represented directly using the `Status` message.
593 #
594 # - Logging. If some API errors are stored in logs, the message `Status` could
595 # be used directly after any stripping needed for security/privacy reasons.
596 "message": "A String", # A developer-facing error message, which should be in English. Any
597 # user-facing error message should be localized and sent in the
598 # google.rpc.Status.details field, or localized by the client.
599 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
600 "details": [ # A list of messages that carry the error details. There will be a
601 # common set of message types for APIs to use.
602 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]603 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]604 },
605 ],
606 },
607 }</pre>
608</div>
609
610<div class="method">
611 <code class="details" id="get">get(projectId, id, x__xgafv=None)</code>
612 <pre>Returns information about a previously requested build.
613
614The Build that is returned includes its status (e.g., success or failure,
615or in-progress), and timing information.
616
617Args:
618 projectId: string, ID of the project. (required)
619 id: string, ID of the build. (required)
620 x__xgafv: string, V1 error format.
621 Allowed values
622 1 - v1 error format
623 2 - v2 error format
624
625Returns:
626 An object of the form:
627
628 { # A build resource in the Container Builder API.
629 #
630 # At a high level, a Build describes where to find source code, how to build
631 # it (for example, the builder image to run on the source), and what tag to
632 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]633 #
634 # Fields can include the following variables which will be expanded when the
635 # build is created:
636 #
637 # - $PROJECT_ID: the project ID of the build.
638 # - $BUILD_ID: the autogenerated ID of the build.
639 # - $REPO_NAME: the source repository name specified by RepoSource.
640 # - $BRANCH_NAME: the branch name specified by RepoSource.
641 # - $TAG_NAME: the tag name specified by RepoSource.
642 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
643 # resolved from the specified branch or tag.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]644 "status": "A String", # Status of the build.
645 # @OutputOnly
646 "finishTime": "A String", # Time at which execution of the build was finished.
647 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]648 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
649 # granularity. If this amount of time elapses, work on the build will cease
650 # and the build status will be TIMEOUT.
651 #
652 # Default time is ten minutes.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]653 "statusDetail": "A String", # Customer-readable message about the current status.
654 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]655 "startTime": "A String", # Time at which execution of the build was started.
656 # @OutputOnly
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]657 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
658 # [Bucket Name
659 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
660 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
661 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
662 # @OutputOnly
663 "images": [ # Images that were built as a part of the build.
664 { # BuiltImage describes an image built by the pipeline.
665 "name": "A String", # Name used to push the container image to Google Container Registry, as
666 # presented to `docker push`.
667 "digest": "A String", # Docker Registry 2.0 digest.
668 },
669 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]670 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
671 "A String",
672 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]673 },
674 "createTime": "A String", # Time at which the build was created.
675 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]676 "id": "A String", # Unique identifier of the build.
677 # @OutputOnly
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]678 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
679 # service.
680 "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
681 # Storage.
682 # Google Cloud Storage.
683 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
684 # omitted, the latest generation will be used.
685 "object": "A String", # Google Cloud Storage object containing source.
686 #
687 # This object must be a gzipped archive file (.tar.gz) containing source to
688 # build.
689 "bucket": "A String", # Google Cloud Storage bucket containing source (see
690 # [Bucket Name
691 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
692 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]693 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
694 # Repository.
695 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
696 # the build is assumed.
697 "branchName": "A String", # Name of the branch to build.
698 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
699 "tagName": "A String", # Name of the tag to build.
700 "commitSha": "A String", # Explicit commit SHA to build.
701 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]702 },
703 "steps": [ # Describes the operations to be performed on the workspace.
704 { # BuildStep describes a step to perform in the build pipeline.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]705 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
706 # This build step will not start until all the build steps in wait_for
707 # have completed successfully. If wait_for is empty, this build step will
708 # start when all previous build steps in the Build.Steps list have completed
709 # successfully.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]710 "A String",
711 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]712 "name": "A String", # The name of the container image that will run this particular build step.
713 #
714 # If the image is already available in the host's
715 # Docker daemon's cache, it will be run directly. If not, the host will
716 # attempt to pull the image first, using the builder service account's
717 # credentials if necessary.
718 #
719 # The Docker daemon's cache will already have the latest versions of all of
720 # the officially supported build steps
721 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
722 # will also have cached many of the layers for some popular images, like
723 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
724 # use them.
725 #
726 # If you built an image in a previous build step, it will be stored in the
727 # host's Docker daemon's cache and is available to use as the name for a
728 # later build step.
729 "args": [ # A list of arguments that will be presented to the step when it is started.
730 #
731 # If the image used to run the step's container has an entrypoint, these args
732 # will be used as arguments to that entrypoint. If the image does not define
733 # an entrypoint, the first element in args will be used as the entrypoint,
734 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]735 "A String",
736 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]737 "env": [ # A list of environment variable definitions to be used when running a step.
738 #
739 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
740 # being given the value "VALUE".
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]741 "A String",
742 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]743 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
744 # reference this build step as a dependency.
745 "dir": "A String", # Working directory (relative to project source root) to use when running
746 # this operation's container.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]747 },
748 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]749 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
750 # @OutputOnly
751 # some source was used for this build.
752 "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
753 # revisions resolved.
754 # Repository.
755 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
756 # the build is assumed.
757 "branchName": "A String", # Name of the branch to build.
758 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
759 "tagName": "A String", # Name of the tag to build.
760 "commitSha": "A String", # Explicit commit SHA to build.
761 },
762 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
763 # source integrity was maintained in the build. Note that FileHashes will
764 # only be populated if BuildOptions has requested a SourceProvenanceHash.
765 #
766 # The keys to this map are file paths used as build source and the values
767 # contain the hash values for those files.
768 #
769 # If the build source came in a single package such as a gzipped tarfile
770 # (.tar.gz), the FileHash will be for the single path to that file.
771 # @OutputOnly
772 "a_key": { # Container message for hashes of byte content of files, used in
773 # SourceProvenance messages to verify integrity of source input to the build.
774 "fileHash": [ # Collection of file hashes.
775 { # Container message for hash values.
776 "type": "A String", # The type of hash that was performed.
777 "value": "A String", # The hash value.
778 },
779 ],
780 },
781 },
782 "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
783 # generations resolved.
784 # Google Cloud Storage.
785 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
786 # omitted, the latest generation will be used.
787 "object": "A String", # Google Cloud Storage object containing source.
788 #
789 # This object must be a gzipped archive file (.tar.gz) containing source to
790 # build.
791 "bucket": "A String", # Google Cloud Storage bucket containing source (see
792 # [Bucket Name
793 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
794 },
795 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]796 "projectId": "A String", # ID of the project.
797 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]798 "images": [ # A list of images to be pushed upon the successful completion of all build
799 # steps.
800 #
801 # The images will be pushed using the builder
802 # service account's credentials.
803 #
804 # The digests of the pushed images will be stored in the Build resource's
805 # results field.
806 #
807 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]808 "A String",
809 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]810 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]811 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]812 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
813 "A String",
814 ],
815 },
816 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]817 # @OutputOnly
818 }</pre>
819</div>
820
821<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]822 <code class="details" id="list">list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]823 <pre>Lists previously requested builds.
824
825Previously requested builds may still be in-progress, or may have finished
826successfully or unsuccessfully.
827
828Args:
829 projectId: string, ID of the project. (required)
830 pageSize: integer, Number of results to return in the list.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]831 filter: string, The raw filter text to constrain the results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]832 pageToken: string, Token to provide to skip to a particular spot in the list.
833 x__xgafv: string, V1 error format.
834 Allowed values
835 1 - v1 error format
836 2 - v2 error format
837
838Returns:
839 An object of the form:
840
841 { # Response including listed builds.
842 "nextPageToken": "A String", # Token to receive the next page of results.
843 "builds": [ # Builds will be sorted by create_time, descending.
844 { # A build resource in the Container Builder API.
845 #
846 # At a high level, a Build describes where to find source code, how to build
847 # it (for example, the builder image to run on the source), and what tag to
848 # apply to the built image when it is pushed to Google Container Registry.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]849 #
850 # Fields can include the following variables which will be expanded when the
851 # build is created:
852 #
853 # - $PROJECT_ID: the project ID of the build.
854 # - $BUILD_ID: the autogenerated ID of the build.
855 # - $REPO_NAME: the source repository name specified by RepoSource.
856 # - $BRANCH_NAME: the branch name specified by RepoSource.
857 # - $TAG_NAME: the tag name specified by RepoSource.
858 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
859 # resolved from the specified branch or tag.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]860 "status": "A String", # Status of the build.
861 # @OutputOnly
862 "finishTime": "A String", # Time at which execution of the build was finished.
863 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]864 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
865 # granularity. If this amount of time elapses, work on the build will cease
866 # and the build status will be TIMEOUT.
867 #
868 # Default time is ten minutes.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]869 "statusDetail": "A String", # Customer-readable message about the current status.
870 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]871 "startTime": "A String", # Time at which execution of the build was started.
872 # @OutputOnly
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]873 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
874 # [Bucket Name
875 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
876 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
877 "results": { # Results describes the artifacts created by the build pipeline. # Results of the build.
878 # @OutputOnly
879 "images": [ # Images that were built as a part of the build.
880 { # BuiltImage describes an image built by the pipeline.
881 "name": "A String", # Name used to push the container image to Google Container Registry, as
882 # presented to `docker push`.
883 "digest": "A String", # Docker Registry 2.0 digest.
884 },
885 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]886 "buildStepImages": [ # List of build step digests, in order corresponding to build step indices.
887 "A String",
888 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]889 },
890 "createTime": "A String", # Time at which the build was created.
891 # @OutputOnly
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]892 "id": "A String", # Unique identifier of the build.
893 # @OutputOnly
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]894 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
895 # service.
896 "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
897 # Storage.
898 # Google Cloud Storage.
899 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
900 # omitted, the latest generation will be used.
901 "object": "A String", # Google Cloud Storage object containing source.
902 #
903 # This object must be a gzipped archive file (.tar.gz) containing source to
904 # build.
905 "bucket": "A String", # Google Cloud Storage bucket containing source (see
906 # [Bucket Name
907 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
908 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]909 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
910 # Repository.
911 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
912 # the build is assumed.
913 "branchName": "A String", # Name of the branch to build.
914 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
915 "tagName": "A String", # Name of the tag to build.
916 "commitSha": "A String", # Explicit commit SHA to build.
917 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]918 },
919 "steps": [ # Describes the operations to be performed on the workspace.
920 { # BuildStep describes a step to perform in the build pipeline.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]921 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
922 # This build step will not start until all the build steps in wait_for
923 # have completed successfully. If wait_for is empty, this build step will
924 # start when all previous build steps in the Build.Steps list have completed
925 # successfully.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]926 "A String",
927 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]928 "name": "A String", # The name of the container image that will run this particular build step.
929 #
930 # If the image is already available in the host's
931 # Docker daemon's cache, it will be run directly. If not, the host will
932 # attempt to pull the image first, using the builder service account's
933 # credentials if necessary.
934 #
935 # The Docker daemon's cache will already have the latest versions of all of
936 # the officially supported build steps
937 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
938 # will also have cached many of the layers for some popular images, like
939 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
940 # use them.
941 #
942 # If you built an image in a previous build step, it will be stored in the
943 # host's Docker daemon's cache and is available to use as the name for a
944 # later build step.
945 "args": [ # A list of arguments that will be presented to the step when it is started.
946 #
947 # If the image used to run the step's container has an entrypoint, these args
948 # will be used as arguments to that entrypoint. If the image does not define
949 # an entrypoint, the first element in args will be used as the entrypoint,
950 # and the remainder will be used as arguments.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]951 "A String",
952 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]953 "env": [ # A list of environment variable definitions to be used when running a step.
954 #
955 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
956 # being given the value "VALUE".
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]957 "A String",
958 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]959 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
960 # reference this build step as a dependency.
961 "dir": "A String", # Working directory (relative to project source root) to use when running
962 # this operation's container.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]963 },
964 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]965 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
966 # @OutputOnly
967 # some source was used for this build.
968 "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
969 # revisions resolved.
970 # Repository.
971 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
972 # the build is assumed.
973 "branchName": "A String", # Name of the branch to build.
974 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
975 "tagName": "A String", # Name of the tag to build.
976 "commitSha": "A String", # Explicit commit SHA to build.
977 },
978 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
979 # source integrity was maintained in the build. Note that FileHashes will
980 # only be populated if BuildOptions has requested a SourceProvenanceHash.
981 #
982 # The keys to this map are file paths used as build source and the values
983 # contain the hash values for those files.
984 #
985 # If the build source came in a single package such as a gzipped tarfile
986 # (.tar.gz), the FileHash will be for the single path to that file.
987 # @OutputOnly
988 "a_key": { # Container message for hashes of byte content of files, used in
989 # SourceProvenance messages to verify integrity of source input to the build.
990 "fileHash": [ # Collection of file hashes.
991 { # Container message for hash values.
992 "type": "A String", # The type of hash that was performed.
993 "value": "A String", # The hash value.
994 },
995 ],
996 },
997 },
998 "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
999 # generations resolved.
1000 # Google Cloud Storage.
1001 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1002 # omitted, the latest generation will be used.
1003 "object": "A String", # Google Cloud Storage object containing source.
1004 #
1005 # This object must be a gzipped archive file (.tar.gz) containing source to
1006 # build.
1007 "bucket": "A String", # Google Cloud Storage bucket containing source (see
1008 # [Bucket Name
1009 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1010 },
1011 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1012 "projectId": "A String", # ID of the project.
1013 # @OutputOnly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]1014 "images": [ # A list of images to be pushed upon the successful completion of all build
1015 # steps.
1016 #
1017 # The images will be pushed using the builder
1018 # service account's credentials.
1019 #
1020 # The digests of the pushed images will be stored in the Build resource's
1021 # results field.
1022 #
1023 # If any of the images fail to be pushed, the build is marked FAILURE.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1024 "A String",
1025 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1026 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]1027 "requestedVerifyOption": "A String", # Requested verifiability options.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1028 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
1029 "A String",
1030 ],
1031 },
1032 "logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1033 # @OutputOnly
1034 },
1035 ],
1036 }</pre>
1037</div>
1038
1039<div class="method">
1040 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1041 <pre>Retrieves the next page of results.
1042
1043Args:
1044 previous_request: The request for the previous page. (required)
1045 previous_response: The response from the request for the previous page. (required)
1046
1047Returns:
1048 A request object that you can call 'execute()' on to request the next
1049 page. Returns None if there are no more items in the collection.
1050 </pre>
1051</div>
1052
1053</body></html>