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