Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / cloudbuild_v1.projects.builds.html
blob: 16c84059e42b3945f7b01aeb335da5f6bbe95531 [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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="cloudbuild_v1.html">Cloud Build API</a> . <a href="cloudbuild_v1.projects.html">projects</a> . <a href="cloudbuild_v1.projects.builds.html">builds</a></h1>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#cancel">cancel(projectId, id, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Cancels a build in progress.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87 <code><a href="#list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None, filter=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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#retry">retry(projectId, id, body=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Creates a new build based on the specified build.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97 <code class="details" id="cancel">cancel(projectId, id, body=None, x__xgafv=None)</code>
98 <pre>Cancels a build in progress.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]99
100Args:
101 projectId: string, ID of the project. (required)
102 id: string, ID of the build. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]104 The object takes the form of:
105
106{ # Request to cancel an ongoing build.
107 }
108
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 An object of the form:
116
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 { # A build resource in the Cloud Build API.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]118 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 # At a high level, a `Build` describes where to find source code, how to build
120 # it (for example, the builder image to run on the source), and where to store
121 # the built artifacts.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]122 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 # Fields can include the following variables, which will be expanded when the
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]124 # build is created:
125 #
126 # - $PROJECT_ID: the project ID of the build.
127 # - $BUILD_ID: the autogenerated ID of the build.
128 # - $REPO_NAME: the source repository name specified by RepoSource.
129 # - $BRANCH_NAME: the branch name specified by RepoSource.
130 # - $TAG_NAME: the tag name specified by RepoSource.
131 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
132 # resolved from the specified branch or tag.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 # - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
134 "results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
135 "buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order
136 # corresponding to build step indices.
137 #
138 # [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)
139 # can produce this output by writing to `$BUILDER_OUTPUT/output`.
140 # Only the first 4KB of data is stored.
141 "A String",
142 ],
143 "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts.
144 "endTime": "A String", # End of time span.
145 "startTime": "A String", # Start of time span.
146 },
147 "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
148 "images": [ # Container images that were built as a part of the build.
149 { # An image built by the pipeline.
150 "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.
151 "endTime": "A String", # End of time span.
152 "startTime": "A String", # Start of time span.
153 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]154 "name": "A String", # Name used to push the container image to Google Container Registry, as
155 # presented to `docker push`.
156 "digest": "A String", # Docker Registry 2.0 digest.
157 },
158 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 "buildStepImages": [ # List of build step digests, in the order corresponding to build step
160 # indices.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]161 "A String",
162 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]164 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
166 # some source was used for this build.
167 "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
168 # revisions resolved.
169 "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
170 # project ID requesting the build is assumed.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]171 "commitSha": "A String", # Explicit commit SHA to build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 "repoName": "A String", # Name of the Cloud Source Repository. If omitted, the name "default" is
173 # assumed.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]174 "tagName": "A String", # Name of the tag to build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 "branchName": "A String", # Name of the branch to build.
176 "dir": "A String", # Directory, relative to the source root, in which to run the build.
177 #
178 # This must be a relative path. If a step's `dir` is specified and is an
179 # absolute path, this value is ignored for that step's execution.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]180 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
182 # the original source integrity was maintained in the build. Note that
183 # `FileHashes` will only be populated if `BuildOptions` has requested a
184 # `SourceProvenanceHash`.
185 #
186 # The keys to this map are file paths used as build source and the values
187 # contain the hash values for those files.
188 #
189 # If the build source came in a single package such as a gzipped tarfile
190 # (`.tar.gz`), the `FileHash` will be for the single path to that file.
191 "a_key": { # Container message for hashes of byte content of files, used in
192 # SourceProvenance messages to verify integrity of source input to the build.
193 "fileHash": [ # Collection of file hashes.
194 { # Container message for hash values.
195 "type": "A String", # The type of hash that was performed.
196 "value": "A String", # The hash value.
197 },
198 ],
199 },
200 },
201 "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
202 # generations resolved.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]203 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
204 # omitted, the latest generation will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 "object": "A String", # Google Cloud Storage object containing the source.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]206 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 # This object must be a gzipped archive file (`.tar.gz`) containing source to
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]208 # build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 "bucket": "A String", # Google Cloud Storage bucket containing the source (see
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]210 # [Bucket Name
211 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
212 },
213 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 "images": [ # A list of images to be pushed upon the successful completion of all build
215 # steps.
216 #
217 # The images are pushed using the builder service account's credentials.
218 #
219 # The digests of the pushed images will be stored in the `Build` resource's
220 # results field.
221 #
222 # If any of the images fail to be pushed, the build status is marked
223 # `FAILURE`.
224 "A String",
225 ],
226 "id": "A String", # Output only. Unique identifier of the build.
227 "artifacts": { # Artifacts produced by a build that should be uploaded upon # Artifacts produced by the build that should be uploaded upon
228 # successful completion of all build steps.
229 # successful completion of all build steps.
230 "images": [ # A list of images to be pushed upon the successful completion of all build
231 # steps.
232 #
233 # The images will be pushed using the builder service account's credentials.
234 #
235 # The digests of the pushed images will be stored in the Build resource's
236 # results field.
237 #
238 # If any of the images fail to be pushed, the build is marked FAILURE.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]239 "A String",
240 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 "objects": { # Files in the workspace to upload to Cloud Storage upon successful # A list of objects to be uploaded to Cloud Storage upon successful
242 # completion of all build steps.
243 #
244 # Files in the workspace matching specified paths globs will be uploaded to
245 # the specified Cloud Storage location using the builder service account's
246 # credentials.
247 #
248 # The location and generation of the uploaded objects will be stored in the
249 # Build resource's results field.
250 #
251 # If any objects fail to be pushed, the build is marked FAILURE.
252 # completion of all build steps.
253 "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.
254 "endTime": "A String", # End of time span.
255 "startTime": "A String", # Start of time span.
256 },
257 "paths": [ # Path globs used to match files in the build's workspace.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]258 "A String",
259 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]260 "location": "A String", # Cloud Storage bucket and optional object path, in the form
261 # "gs://bucket/path/to/somewhere/". (see [Bucket Name
262 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]263 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264 # Files in the workspace matching any path pattern will be uploaded to
265 # Cloud Storage with this location as a prefix.
266 },
267 },
268 "projectId": "A String", # Output only. ID of the project.
269 "substitutions": { # Substitutions data for `Build` resource.
270 "a_key": "A String",
271 },
272 "source": { # Location of the source in a supported storage service. # The location of the source files to build.
273 "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source
274 # Repository.
275 "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
276 # project ID requesting the build is assumed.
277 "commitSha": "A String", # Explicit commit SHA to build.
278 "repoName": "A String", # Name of the Cloud Source Repository. If omitted, the name "default" is
279 # assumed.
280 "tagName": "A String", # Name of the tag to build.
281 "branchName": "A String", # Name of the branch to build.
282 "dir": "A String", # Directory, relative to the source root, in which to run the build.
283 #
284 # This must be a relative path. If a step's `dir` is specified and is an
285 # absolute path, this value is ignored for that step's execution.
286 },
287 "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
288 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
289 # omitted, the latest generation will be used.
290 "object": "A String", # Google Cloud Storage object containing the source.
291 #
292 # This object must be a gzipped archive file (`.tar.gz`) containing source to
293 # build.
294 "bucket": "A String", # Google Cloud Storage bucket containing the source (see
295 # [Bucket Name
296 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
297 },
298 },
299 "status": "A String", # Output only. Status of the build.
300 "tags": [ # Tags for annotation of a `Build`. These are not docker tags.
301 "A String",
302 ],
303 "statusDetail": "A String", # Output only. Customer-readable message about the current status.
304 "startTime": "A String", # Output only. Time at which execution of the build was started.
305 "timing": { # Output only. Stores timing information for phases of the build. Valid keys
306 # are:
307 #
308 # * BUILD: time to execute all build steps
309 # * PUSH: time to push all specified images.
310 # * FETCHSOURCE: time to fetch source.
311 #
312 # If the build does not specify source or images,
313 # these keys will not be included.
314 "a_key": { # Start and end times for a build execution phase.
315 "endTime": "A String", # End of time span.
316 "startTime": "A String", # Start of time span.
317 },
318 },
319 "createTime": "A String", # Output only. Time at which the request to create the build was received.
320 "finishTime": "A String", # Output only. Time at which execution of the build was finished.
321 #
322 # The difference between finish_time and start_time is the duration of the
323 # build's execution.
324 "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it
325 # was triggered automatically.
326 "secrets": [ # Secrets to decrypt using Cloud Key Management Service.
327 { # Pairs a set of secret environment variables containing encrypted
328 # values with the Cloud KMS key to use to decrypt the value.
329 "secretEnv": { # Map of environment variable name to its encrypted value.
330 #
331 # Secret environment variables must be unique across all of a build's
332 # secrets, and must be used by at least one build step. Values can be at most
333 # 64 KB in size. There can be at most 100 secret values across all of a
334 # build's secrets.
335 "a_key": "A String",
336 },
337 "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
338 },
339 ],
340 "steps": [ # Required. The operations to be performed on the workspace.
341 { # A step in the build pipeline.
342 "status": "A String", # Output only. Status of the build step. At this time, build step status is
343 # only updated on build completion; step status is not updated in real-time
344 # as the build progresses.
345 "args": [ # A list of arguments that will be presented to the step when it is started.
346 #
347 # If the image used to run the step's container has an entrypoint, the `args`
348 # are used as arguments to that entrypoint. If the image does not define
349 # an entrypoint, the first element in args is used as the entrypoint,
350 # and the remainder will be used as arguments.
351 "A String",
352 ],
353 "env": [ # A list of environment variable definitions to be used when running a step.
354 #
355 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
356 # being given the value "VALUE".
357 "A String",
358 ],
359 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
360 # This build step will not start until all the build steps in `wait_for`
361 # have completed successfully. If `wait_for` is empty, this build step will
362 # start when all previous build steps in the `Build.Steps` list have
363 # completed successfully.
364 "A String",
365 ],
366 "timeout": "A String", # Time limit for executing this build step. If not defined, the step has no
367 # time limit and will be allowed to continue to run until either it completes
368 # or the build itself times out.
369 "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key
370 # Management Service crypto key. These values must be specified in the
371 # build's `Secret`.
372 "A String",
373 ],
374 "entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint.
375 # If unset, the image's default entrypoint is used.
376 "volumes": [ # List of volumes to mount into the build step.
377 #
378 # Each volume is created as an empty volume prior to execution of the
379 # build step. Upon completion of the build, volumes and their contents are
380 # discarded.
381 #
382 # Using a named volume in only one step is not valid as it is indicative
383 # of a build request with an incorrect configuration.
384 { # Volume describes a Docker container volume which is mounted into build steps
385 # in order to persist files across build step execution.
386 "path": "A String", # Path at which to mount the volume.
387 #
388 # Paths must be absolute and cannot conflict with other volume paths on the
389 # same build step or with certain reserved volume paths.
390 "name": "A String", # Name of the volume to mount.
391 #
392 # Volume names must be unique per build step and must be valid names for
393 # Docker volumes. Each named volume must be used by at least two build steps.
394 },
395 ],
396 "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
397 "endTime": "A String", # End of time span.
398 "startTime": "A String", # Start of time span.
399 },
400 "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's
401 # builder image only.
402 "endTime": "A String", # End of time span.
403 "startTime": "A String", # Start of time span.
404 },
405 "id": "A String", # Unique identifier for this build step, used in `wait_for` to
406 # reference this build step as a dependency.
407 "dir": "A String", # Working directory to use when running this step's container.
408 #
409 # If this value is a relative path, it is relative to the build's working
410 # directory. If this value is absolute, it may be outside the build's working
411 # directory, in which case the contents of the path may not be persisted
412 # across build step executions, unless a `volume` for that path is specified.
413 #
414 # If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
415 # which specifies an absolute path, the `RepoSource` `dir` is ignored for
416 # the step's execution.
417 "name": "A String", # Required. The name of the container image that will run this particular
418 # build step.
419 #
420 # If the image is available in the host's Docker daemon's cache, it
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]421 # will be run directly. If not, the host will attempt to pull the image
422 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]423 #
424 # The Docker daemon's cache will already have the latest versions of all of
425 # the officially supported build steps
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]426 # ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
427 # The Docker daemon will also have cached many of the layers for some popular
428 # images, like "ubuntu", "debian", but they will be refreshed at the time you
429 # attempt to use them.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]430 #
431 # If you built an image in a previous build step, it will be stored in the
432 # host's Docker daemon's cache and is available to use as the name for a
433 # later build step.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]434 },
435 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]436 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
437 # granularity. If this amount of time elapses, work on the build will cease
438 # and the build status will be `TIMEOUT`.
439 #
440 # Default time is ten minutes.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]441 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
442 # [Bucket Name
443 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
444 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
446 "substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution
447 # checks.
448 "logging": "A String", # Option to specify the logging mode, which determines where the logs are
449 # stored.
450 "volumes": [ # Global list of volumes to mount for ALL build steps
451 #
452 # Each volume is created as an empty volume prior to starting the build
453 # process. Upon completion of the build, volumes and their contents are
454 # discarded. Global volume names and paths cannot conflict with the volumes
455 # defined a build step.
456 #
457 # Using a global volume in a build with only one step is not valid as
458 # it is indicative of a build request with an incorrect configuration.
459 { # Volume describes a Docker container volume which is mounted into build steps
460 # in order to persist files across build step execution.
461 "path": "A String", # Path at which to mount the volume.
462 #
463 # Paths must be absolute and cannot conflict with other volume paths on the
464 # same build step or with certain reserved volume paths.
465 "name": "A String", # Name of the volume to mount.
466 #
467 # Volume names must be unique per build step and must be valid names for
468 # Docker volumes. Each named volume must be used by at least two build steps.
469 },
470 ],
471 "workerPool": "A String", # Option to specify a `WorkerPool` for the build. User specifies the pool
472 # with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]".
473 # This is an experimental field.
474 "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
475 # Storage.
476 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
477 "A String",
478 ],
479 "secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud
480 # Key Management Service crypto key. These values must be specified in the
481 # build's `Secret`. These variables will be available to all build steps
482 # in this build.
483 "A String",
484 ],
485 "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*
486 # "disk free"; some of the space will be used by the operating system and
487 # build utilities. Also note that this is the minimum disk size that will be
488 # allocated for the build -- the build may run with a larger disk than
489 # requested. At present, the maximum disk size is 1000GB; builds that request
490 # more than the maximum are rejected with an error.
491 "env": [ # A list of global environment variable definitions that will exist for all
492 # build steps in this build. If a variable is defined in both globally and in
493 # a build step, the variable will use the build step value.
494 #
495 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
496 # being given the value "VALUE".
497 "A String",
498 ],
499 "requestedVerifyOption": "A String", # Requested verifiability options.
500 "machineType": "A String", # Compute Engine machine type on which to run the build.
501 },
502 "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.
503 }</pre>
504</div>
505
506<div class="method">
507 <code class="details" id="create">create(projectId, body, x__xgafv=None)</code>
508 <pre>Starts a build with the specified configuration.
509
510This method returns a long-running `Operation`, which includes the build
511ID. Pass the build ID to `GetBuild` to determine the build status (such as
512`SUCCESS` or `FAILURE`).
513
514Args:
515 projectId: string, ID of the project. (required)
516 body: object, The request body. (required)
517 The object takes the form of:
518
519{ # A build resource in the Cloud Build API.
520 #
521 # At a high level, a `Build` describes where to find source code, how to build
522 # it (for example, the builder image to run on the source), and where to store
523 # the built artifacts.
524 #
525 # Fields can include the following variables, which will be expanded when the
526 # build is created:
527 #
528 # - $PROJECT_ID: the project ID of the build.
529 # - $BUILD_ID: the autogenerated ID of the build.
530 # - $REPO_NAME: the source repository name specified by RepoSource.
531 # - $BRANCH_NAME: the branch name specified by RepoSource.
532 # - $TAG_NAME: the tag name specified by RepoSource.
533 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
534 # resolved from the specified branch or tag.
535 # - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
536 "results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
537 "buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order
538 # corresponding to build step indices.
539 #
540 # [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)
541 # can produce this output by writing to `$BUILDER_OUTPUT/output`.
542 # Only the first 4KB of data is stored.
543 "A String",
544 ],
545 "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts.
546 "endTime": "A String", # End of time span.
547 "startTime": "A String", # Start of time span.
548 },
549 "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
550 "images": [ # Container images that were built as a part of the build.
551 { # An image built by the pipeline.
552 "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.
553 "endTime": "A String", # End of time span.
554 "startTime": "A String", # Start of time span.
555 },
556 "name": "A String", # Name used to push the container image to Google Container Registry, as
557 # presented to `docker push`.
558 "digest": "A String", # Docker Registry 2.0 digest.
559 },
560 ],
561 "buildStepImages": [ # List of build step digests, in the order corresponding to build step
562 # indices.
563 "A String",
564 ],
565 "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
566 },
567 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
568 # some source was used for this build.
569 "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
570 # revisions resolved.
571 "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
572 # project ID requesting the build is assumed.
573 "commitSha": "A String", # Explicit commit SHA to build.
574 "repoName": "A String", # Name of the Cloud Source Repository. If omitted, the name "default" is
575 # assumed.
576 "tagName": "A String", # Name of the tag to build.
577 "branchName": "A String", # Name of the branch to build.
578 "dir": "A String", # Directory, relative to the source root, in which to run the build.
579 #
580 # This must be a relative path. If a step's `dir` is specified and is an
581 # absolute path, this value is ignored for that step's execution.
582 },
583 "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
584 # the original source integrity was maintained in the build. Note that
585 # `FileHashes` will only be populated if `BuildOptions` has requested a
586 # `SourceProvenanceHash`.
587 #
588 # The keys to this map are file paths used as build source and the values
589 # contain the hash values for those files.
590 #
591 # If the build source came in a single package such as a gzipped tarfile
592 # (`.tar.gz`), the `FileHash` will be for the single path to that file.
593 "a_key": { # Container message for hashes of byte content of files, used in
594 # SourceProvenance messages to verify integrity of source input to the build.
595 "fileHash": [ # Collection of file hashes.
596 { # Container message for hash values.
597 "type": "A String", # The type of hash that was performed.
598 "value": "A String", # The hash value.
599 },
600 ],
601 },
602 },
603 "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
604 # generations resolved.
605 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
606 # omitted, the latest generation will be used.
607 "object": "A String", # Google Cloud Storage object containing the source.
608 #
609 # This object must be a gzipped archive file (`.tar.gz`) containing source to
610 # build.
611 "bucket": "A String", # Google Cloud Storage bucket containing the source (see
612 # [Bucket Name
613 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
614 },
615 },
616 "images": [ # A list of images to be pushed upon the successful completion of all build
617 # steps.
618 #
619 # The images are pushed using the builder service account's credentials.
620 #
621 # The digests of the pushed images will be stored in the `Build` resource's
622 # results field.
623 #
624 # If any of the images fail to be pushed, the build status is marked
625 # `FAILURE`.
626 "A String",
627 ],
628 "id": "A String", # Output only. Unique identifier of the build.
629 "artifacts": { # Artifacts produced by a build that should be uploaded upon # Artifacts produced by the build that should be uploaded upon
630 # successful completion of all build steps.
631 # successful completion of all build steps.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]632 "images": [ # A list of images to be pushed upon the successful completion of all build
633 # steps.
634 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]635 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]636 #
637 # The digests of the pushed images will be stored in the Build resource's
638 # results field.
639 #
640 # 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]641 "A String",
642 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]643 "objects": { # Files in the workspace to upload to Cloud Storage upon successful # A list of objects to be uploaded to Cloud Storage upon successful
644 # completion of all build steps.
645 #
646 # Files in the workspace matching specified paths globs will be uploaded to
647 # the specified Cloud Storage location using the builder service account's
648 # credentials.
649 #
650 # The location and generation of the uploaded objects will be stored in the
651 # Build resource's results field.
652 #
653 # If any objects fail to be pushed, the build is marked FAILURE.
654 # completion of all build steps.
655 "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.
656 "endTime": "A String", # End of time span.
657 "startTime": "A String", # Start of time span.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]658 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]659 "paths": [ # Path globs used to match files in the build's workspace.
660 "A String",
661 ],
662 "location": "A String", # Cloud Storage bucket and optional object path, in the form
663 # "gs://bucket/path/to/somewhere/". (see [Bucket Name
664 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
665 #
666 # Files in the workspace matching any path pattern will be uploaded to
667 # Cloud Storage with this location as a prefix.
668 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]669 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]670 "projectId": "A String", # Output only. ID of the project.
671 "substitutions": { # Substitutions data for `Build` resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]672 "a_key": "A String",
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]673 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]674 "source": { # Location of the source in a supported storage service. # The location of the source files to build.
675 "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]676 # Repository.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]677 "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
678 # project ID requesting the build is assumed.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]679 "commitSha": "A String", # Explicit commit SHA to build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]680 "repoName": "A String", # Name of the Cloud Source Repository. If omitted, the name "default" is
681 # assumed.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]682 "tagName": "A String", # Name of the tag to build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]683 "branchName": "A String", # Name of the branch to build.
684 "dir": "A String", # Directory, relative to the source root, in which to run the build.
685 #
686 # This must be a relative path. If a step's `dir` is specified and is an
687 # absolute path, this value is ignored for that step's execution.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]688 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]689 "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]690 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
691 # omitted, the latest generation will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]692 "object": "A String", # Google Cloud Storage object containing the source.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]693 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]694 # This object must be a gzipped archive file (`.tar.gz`) containing source to
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]695 # build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]696 "bucket": "A String", # Google Cloud Storage bucket containing the source (see
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]697 # [Bucket Name
698 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
699 },
700 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]701 "status": "A String", # Output only. Status of the build.
702 "tags": [ # Tags for annotation of a `Build`. These are not docker tags.
703 "A String",
704 ],
705 "statusDetail": "A String", # Output only. Customer-readable message about the current status.
706 "startTime": "A String", # Output only. Time at which execution of the build was started.
707 "timing": { # Output only. Stores timing information for phases of the build. Valid keys
708 # are:
709 #
710 # * BUILD: time to execute all build steps
711 # * PUSH: time to push all specified images.
712 # * FETCHSOURCE: time to fetch source.
713 #
714 # If the build does not specify source or images,
715 # these keys will not be included.
716 "a_key": { # Start and end times for a build execution phase.
717 "endTime": "A String", # End of time span.
718 "startTime": "A String", # Start of time span.
719 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]720 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]721 "createTime": "A String", # Output only. Time at which the request to create the build was received.
722 "finishTime": "A String", # Output only. Time at which execution of the build was finished.
723 #
724 # The difference between finish_time and start_time is the duration of the
725 # build's execution.
726 "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it
727 # was triggered automatically.
728 "secrets": [ # Secrets to decrypt using Cloud Key Management Service.
729 { # Pairs a set of secret environment variables containing encrypted
730 # values with the Cloud KMS key to use to decrypt the value.
731 "secretEnv": { # Map of environment variable name to its encrypted value.
732 #
733 # Secret environment variables must be unique across all of a build's
734 # secrets, and must be used by at least one build step. Values can be at most
735 # 64 KB in size. There can be at most 100 secret values across all of a
736 # build's secrets.
737 "a_key": "A String",
738 },
739 "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
740 },
741 ],
742 "steps": [ # Required. The operations to be performed on the workspace.
743 { # A step in the build pipeline.
744 "status": "A String", # Output only. Status of the build step. At this time, build step status is
745 # only updated on build completion; step status is not updated in real-time
746 # as the build progresses.
747 "args": [ # A list of arguments that will be presented to the step when it is started.
748 #
749 # If the image used to run the step's container has an entrypoint, the `args`
750 # are used as arguments to that entrypoint. If the image does not define
751 # an entrypoint, the first element in args is used as the entrypoint,
752 # and the remainder will be used as arguments.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]753 "A String",
754 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]755 "env": [ # A list of environment variable definitions to be used when running a step.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]756 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]757 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
758 # being given the value "VALUE".
759 "A String",
760 ],
761 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
762 # This build step will not start until all the build steps in `wait_for`
763 # have completed successfully. If `wait_for` is empty, this build step will
764 # start when all previous build steps in the `Build.Steps` list have
765 # completed successfully.
766 "A String",
767 ],
768 "timeout": "A String", # Time limit for executing this build step. If not defined, the step has no
769 # time limit and will be allowed to continue to run until either it completes
770 # or the build itself times out.
771 "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key
772 # Management Service crypto key. These values must be specified in the
773 # build's `Secret`.
774 "A String",
775 ],
776 "entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint.
777 # If unset, the image's default entrypoint is used.
778 "volumes": [ # List of volumes to mount into the build step.
779 #
780 # Each volume is created as an empty volume prior to execution of the
781 # build step. Upon completion of the build, volumes and their contents are
782 # discarded.
783 #
784 # Using a named volume in only one step is not valid as it is indicative
785 # of a build request with an incorrect configuration.
786 { # Volume describes a Docker container volume which is mounted into build steps
787 # in order to persist files across build step execution.
788 "path": "A String", # Path at which to mount the volume.
789 #
790 # Paths must be absolute and cannot conflict with other volume paths on the
791 # same build step or with certain reserved volume paths.
792 "name": "A String", # Name of the volume to mount.
793 #
794 # Volume names must be unique per build step and must be valid names for
795 # Docker volumes. Each named volume must be used by at least two build steps.
796 },
797 ],
798 "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
799 "endTime": "A String", # End of time span.
800 "startTime": "A String", # Start of time span.
801 },
802 "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's
803 # builder image only.
804 "endTime": "A String", # End of time span.
805 "startTime": "A String", # Start of time span.
806 },
807 "id": "A String", # Unique identifier for this build step, used in `wait_for` to
808 # reference this build step as a dependency.
809 "dir": "A String", # Working directory to use when running this step's container.
810 #
811 # If this value is a relative path, it is relative to the build's working
812 # directory. If this value is absolute, it may be outside the build's working
813 # directory, in which case the contents of the path may not be persisted
814 # across build step executions, unless a `volume` for that path is specified.
815 #
816 # If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
817 # which specifies an absolute path, the `RepoSource` `dir` is ignored for
818 # the step's execution.
819 "name": "A String", # Required. The name of the container image that will run this particular
820 # build step.
821 #
822 # If the image is available in the host's Docker daemon's cache, it
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]823 # will be run directly. If not, the host will attempt to pull the image
824 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]825 #
826 # The Docker daemon's cache will already have the latest versions of all of
827 # the officially supported build steps
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]828 # ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
829 # The Docker daemon will also have cached many of the layers for some popular
830 # images, like "ubuntu", "debian", but they will be refreshed at the time you
831 # attempt to use them.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]832 #
833 # If you built an image in a previous build step, it will be stored in the
834 # host's Docker daemon's cache and is available to use as the name for a
835 # later build step.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]836 },
837 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]838 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
839 # granularity. If this amount of time elapses, work on the build will cease
840 # and the build status will be `TIMEOUT`.
841 #
842 # Default time is ten minutes.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]843 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
844 # [Bucket Name
845 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
846 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]847 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
848 "substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution
849 # checks.
850 "logging": "A String", # Option to specify the logging mode, which determines where the logs are
851 # stored.
852 "volumes": [ # Global list of volumes to mount for ALL build steps
853 #
854 # Each volume is created as an empty volume prior to starting the build
855 # process. Upon completion of the build, volumes and their contents are
856 # discarded. Global volume names and paths cannot conflict with the volumes
857 # defined a build step.
858 #
859 # Using a global volume in a build with only one step is not valid as
860 # it is indicative of a build request with an incorrect configuration.
861 { # Volume describes a Docker container volume which is mounted into build steps
862 # in order to persist files across build step execution.
863 "path": "A String", # Path at which to mount the volume.
864 #
865 # Paths must be absolute and cannot conflict with other volume paths on the
866 # same build step or with certain reserved volume paths.
867 "name": "A String", # Name of the volume to mount.
868 #
869 # Volume names must be unique per build step and must be valid names for
870 # Docker volumes. Each named volume must be used by at least two build steps.
871 },
872 ],
873 "workerPool": "A String", # Option to specify a `WorkerPool` for the build. User specifies the pool
874 # with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]".
875 # This is an experimental field.
876 "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
877 # Storage.
878 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
879 "A String",
880 ],
881 "secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud
882 # Key Management Service crypto key. These values must be specified in the
883 # build's `Secret`. These variables will be available to all build steps
884 # in this build.
885 "A String",
886 ],
887 "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*
888 # "disk free"; some of the space will be used by the operating system and
889 # build utilities. Also note that this is the minimum disk size that will be
890 # allocated for the build -- the build may run with a larger disk than
891 # requested. At present, the maximum disk size is 1000GB; builds that request
892 # more than the maximum are rejected with an error.
893 "env": [ # A list of global environment variable definitions that will exist for all
894 # build steps in this build. If a variable is defined in both globally and in
895 # a build step, the variable will use the build step value.
896 #
897 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
898 # being given the value "VALUE".
899 "A String",
900 ],
901 "requestedVerifyOption": "A String", # Requested verifiability options.
902 "machineType": "A String", # Compute Engine machine type on which to run the build.
903 },
904 "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]905}
906
907 x__xgafv: string, V1 error format.
908 Allowed values
909 1 - v1 error format
910 2 - v2 error format
911
912Returns:
913 An object of the form:
914
915 { # This resource represents a long-running operation that is the result of a
916 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]917 "metadata": { # Service-specific metadata associated with the operation. It typically
918 # contains progress information and common metadata such as create time.
919 # Some services might not provide such metadata. Any method that returns a
920 # long-running operation should document the metadata type, if any.
921 "a_key": "", # Properties of the object. Contains field @type with type URL.
922 },
923 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
924 # different programming environments, including REST APIs and RPC APIs. It is
925 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
926 # three pieces of data: error code, error message, and error details.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]927 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]928 # You can find out more about this error model and how to work with it in the
929 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]930 "message": "A String", # A developer-facing error message, which should be in English. Any
931 # user-facing error message should be localized and sent in the
932 # google.rpc.Status.details field, or localized by the client.
933 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]934 "details": [ # A list of messages that carry the error details. There is a common set of
935 # message types for APIs to use.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]936 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]937 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]938 },
939 ],
940 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]941 "done": True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]942 # If `true`, the operation is completed, and either `error` or `response` is
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]943 # available.
944 "response": { # The normal response of the operation in case of success. If the original
945 # method returns no data on success, such as `Delete`, the response is
946 # `google.protobuf.Empty`. If the original method is standard
947 # `Get`/`Create`/`Update`, the response should be the resource. For other
948 # methods, the response should have the type `XxxResponse`, where `Xxx`
949 # is the original method name. For example, if the original method name
950 # is `TakeSnapshot()`, the inferred response type is
951 # `TakeSnapshotResponse`.
952 "a_key": "", # Properties of the object. Contains field @type with type URL.
953 },
954 "name": "A String", # The server-assigned name, which is only unique within the same service that
955 # originally returns it. If you use the default HTTP mapping, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]956 # `name` should be a resource name ending with `operations/{unique_id}`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]957 }</pre>
958</div>
959
960<div class="method">
961 <code class="details" id="get">get(projectId, id, x__xgafv=None)</code>
962 <pre>Returns information about a previously requested build.
963
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]964The `Build` that is returned includes its status (such as `SUCCESS`,
965`FAILURE`, or `WORKING`), and timing information.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]966
967Args:
968 projectId: string, ID of the project. (required)
969 id: string, ID of the build. (required)
970 x__xgafv: string, V1 error format.
971 Allowed values
972 1 - v1 error format
973 2 - v2 error format
974
975Returns:
976 An object of the form:
977
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]978 { # A build resource in the Cloud Build API.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]979 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]980 # At a high level, a `Build` describes where to find source code, how to build
981 # it (for example, the builder image to run on the source), and where to store
982 # the built artifacts.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]983 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]984 # Fields can include the following variables, which will be expanded when the
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]985 # build is created:
986 #
987 # - $PROJECT_ID: the project ID of the build.
988 # - $BUILD_ID: the autogenerated ID of the build.
989 # - $REPO_NAME: the source repository name specified by RepoSource.
990 # - $BRANCH_NAME: the branch name specified by RepoSource.
991 # - $TAG_NAME: the tag name specified by RepoSource.
992 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
993 # resolved from the specified branch or tag.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]994 # - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
995 "results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
996 "buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order
997 # corresponding to build step indices.
998 #
999 # [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)
1000 # can produce this output by writing to `$BUILDER_OUTPUT/output`.
1001 # Only the first 4KB of data is stored.
1002 "A String",
1003 ],
1004 "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts.
1005 "endTime": "A String", # End of time span.
1006 "startTime": "A String", # Start of time span.
1007 },
1008 "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
1009 "images": [ # Container images that were built as a part of the build.
1010 { # An image built by the pipeline.
1011 "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.
1012 "endTime": "A String", # End of time span.
1013 "startTime": "A String", # Start of time span.
1014 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1015 "name": "A String", # Name used to push the container image to Google Container Registry, as
1016 # presented to `docker push`.
1017 "digest": "A String", # Docker Registry 2.0 digest.
1018 },
1019 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1020 "buildStepImages": [ # List of build step digests, in the order corresponding to build step
1021 # indices.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1022 "A String",
1023 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1024 "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1025 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1026 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
1027 # some source was used for this build.
1028 "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
1029 # revisions resolved.
1030 "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
1031 # project ID requesting the build is assumed.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1032 "commitSha": "A String", # Explicit commit SHA to build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1033 "repoName": "A String", # Name of the Cloud Source Repository. If omitted, the name "default" is
1034 # assumed.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1035 "tagName": "A String", # Name of the tag to build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1036 "branchName": "A String", # Name of the branch to build.
1037 "dir": "A String", # Directory, relative to the source root, in which to run the build.
1038 #
1039 # This must be a relative path. If a step's `dir` is specified and is an
1040 # absolute path, this value is ignored for that step's execution.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1041 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1042 "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
1043 # the original source integrity was maintained in the build. Note that
1044 # `FileHashes` will only be populated if `BuildOptions` has requested a
1045 # `SourceProvenanceHash`.
1046 #
1047 # The keys to this map are file paths used as build source and the values
1048 # contain the hash values for those files.
1049 #
1050 # If the build source came in a single package such as a gzipped tarfile
1051 # (`.tar.gz`), the `FileHash` will be for the single path to that file.
1052 "a_key": { # Container message for hashes of byte content of files, used in
1053 # SourceProvenance messages to verify integrity of source input to the build.
1054 "fileHash": [ # Collection of file hashes.
1055 { # Container message for hash values.
1056 "type": "A String", # The type of hash that was performed.
1057 "value": "A String", # The hash value.
1058 },
1059 ],
1060 },
1061 },
1062 "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
1063 # generations resolved.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1064 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1065 # omitted, the latest generation will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1066 "object": "A String", # Google Cloud Storage object containing the source.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1067 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1068 # This object must be a gzipped archive file (`.tar.gz`) containing source to
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1069 # build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1070 "bucket": "A String", # Google Cloud Storage bucket containing the source (see
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1071 # [Bucket Name
1072 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1073 },
1074 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1075 "images": [ # A list of images to be pushed upon the successful completion of all build
1076 # steps.
1077 #
1078 # The images are pushed using the builder service account's credentials.
1079 #
1080 # The digests of the pushed images will be stored in the `Build` resource's
1081 # results field.
1082 #
1083 # If any of the images fail to be pushed, the build status is marked
1084 # `FAILURE`.
1085 "A String",
1086 ],
1087 "id": "A String", # Output only. Unique identifier of the build.
1088 "artifacts": { # Artifacts produced by a build that should be uploaded upon # Artifacts produced by the build that should be uploaded upon
1089 # successful completion of all build steps.
1090 # successful completion of all build steps.
1091 "images": [ # A list of images to be pushed upon the successful completion of all build
1092 # steps.
1093 #
1094 # The images will be pushed using the builder service account's credentials.
1095 #
1096 # The digests of the pushed images will be stored in the Build resource's
1097 # results field.
1098 #
1099 # If any of the images fail to be pushed, the build is marked FAILURE.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1100 "A String",
1101 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1102 "objects": { # Files in the workspace to upload to Cloud Storage upon successful # A list of objects to be uploaded to Cloud Storage upon successful
1103 # completion of all build steps.
1104 #
1105 # Files in the workspace matching specified paths globs will be uploaded to
1106 # the specified Cloud Storage location using the builder service account's
1107 # credentials.
1108 #
1109 # The location and generation of the uploaded objects will be stored in the
1110 # Build resource's results field.
1111 #
1112 # If any objects fail to be pushed, the build is marked FAILURE.
1113 # completion of all build steps.
1114 "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.
1115 "endTime": "A String", # End of time span.
1116 "startTime": "A String", # Start of time span.
1117 },
1118 "paths": [ # Path globs used to match files in the build's workspace.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1119 "A String",
1120 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1121 "location": "A String", # Cloud Storage bucket and optional object path, in the form
1122 # "gs://bucket/path/to/somewhere/". (see [Bucket Name
1123 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1124 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1125 # Files in the workspace matching any path pattern will be uploaded to
1126 # Cloud Storage with this location as a prefix.
1127 },
1128 },
1129 "projectId": "A String", # Output only. ID of the project.
1130 "substitutions": { # Substitutions data for `Build` resource.
1131 "a_key": "A String",
1132 },
1133 "source": { # Location of the source in a supported storage service. # The location of the source files to build.
1134 "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source
1135 # Repository.
1136 "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
1137 # project ID requesting the build is assumed.
1138 "commitSha": "A String", # Explicit commit SHA to build.
1139 "repoName": "A String", # Name of the Cloud Source Repository. If omitted, the name "default" is
1140 # assumed.
1141 "tagName": "A String", # Name of the tag to build.
1142 "branchName": "A String", # Name of the branch to build.
1143 "dir": "A String", # Directory, relative to the source root, in which to run the build.
1144 #
1145 # This must be a relative path. If a step's `dir` is specified and is an
1146 # absolute path, this value is ignored for that step's execution.
1147 },
1148 "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
1149 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1150 # omitted, the latest generation will be used.
1151 "object": "A String", # Google Cloud Storage object containing the source.
1152 #
1153 # This object must be a gzipped archive file (`.tar.gz`) containing source to
1154 # build.
1155 "bucket": "A String", # Google Cloud Storage bucket containing the source (see
1156 # [Bucket Name
1157 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1158 },
1159 },
1160 "status": "A String", # Output only. Status of the build.
1161 "tags": [ # Tags for annotation of a `Build`. These are not docker tags.
1162 "A String",
1163 ],
1164 "statusDetail": "A String", # Output only. Customer-readable message about the current status.
1165 "startTime": "A String", # Output only. Time at which execution of the build was started.
1166 "timing": { # Output only. Stores timing information for phases of the build. Valid keys
1167 # are:
1168 #
1169 # * BUILD: time to execute all build steps
1170 # * PUSH: time to push all specified images.
1171 # * FETCHSOURCE: time to fetch source.
1172 #
1173 # If the build does not specify source or images,
1174 # these keys will not be included.
1175 "a_key": { # Start and end times for a build execution phase.
1176 "endTime": "A String", # End of time span.
1177 "startTime": "A String", # Start of time span.
1178 },
1179 },
1180 "createTime": "A String", # Output only. Time at which the request to create the build was received.
1181 "finishTime": "A String", # Output only. Time at which execution of the build was finished.
1182 #
1183 # The difference between finish_time and start_time is the duration of the
1184 # build's execution.
1185 "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it
1186 # was triggered automatically.
1187 "secrets": [ # Secrets to decrypt using Cloud Key Management Service.
1188 { # Pairs a set of secret environment variables containing encrypted
1189 # values with the Cloud KMS key to use to decrypt the value.
1190 "secretEnv": { # Map of environment variable name to its encrypted value.
1191 #
1192 # Secret environment variables must be unique across all of a build's
1193 # secrets, and must be used by at least one build step. Values can be at most
1194 # 64 KB in size. There can be at most 100 secret values across all of a
1195 # build's secrets.
1196 "a_key": "A String",
1197 },
1198 "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
1199 },
1200 ],
1201 "steps": [ # Required. The operations to be performed on the workspace.
1202 { # A step in the build pipeline.
1203 "status": "A String", # Output only. Status of the build step. At this time, build step status is
1204 # only updated on build completion; step status is not updated in real-time
1205 # as the build progresses.
1206 "args": [ # A list of arguments that will be presented to the step when it is started.
1207 #
1208 # If the image used to run the step's container has an entrypoint, the `args`
1209 # are used as arguments to that entrypoint. If the image does not define
1210 # an entrypoint, the first element in args is used as the entrypoint,
1211 # and the remainder will be used as arguments.
1212 "A String",
1213 ],
1214 "env": [ # A list of environment variable definitions to be used when running a step.
1215 #
1216 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
1217 # being given the value "VALUE".
1218 "A String",
1219 ],
1220 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
1221 # This build step will not start until all the build steps in `wait_for`
1222 # have completed successfully. If `wait_for` is empty, this build step will
1223 # start when all previous build steps in the `Build.Steps` list have
1224 # completed successfully.
1225 "A String",
1226 ],
1227 "timeout": "A String", # Time limit for executing this build step. If not defined, the step has no
1228 # time limit and will be allowed to continue to run until either it completes
1229 # or the build itself times out.
1230 "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key
1231 # Management Service crypto key. These values must be specified in the
1232 # build's `Secret`.
1233 "A String",
1234 ],
1235 "entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint.
1236 # If unset, the image's default entrypoint is used.
1237 "volumes": [ # List of volumes to mount into the build step.
1238 #
1239 # Each volume is created as an empty volume prior to execution of the
1240 # build step. Upon completion of the build, volumes and their contents are
1241 # discarded.
1242 #
1243 # Using a named volume in only one step is not valid as it is indicative
1244 # of a build request with an incorrect configuration.
1245 { # Volume describes a Docker container volume which is mounted into build steps
1246 # in order to persist files across build step execution.
1247 "path": "A String", # Path at which to mount the volume.
1248 #
1249 # Paths must be absolute and cannot conflict with other volume paths on the
1250 # same build step or with certain reserved volume paths.
1251 "name": "A String", # Name of the volume to mount.
1252 #
1253 # Volume names must be unique per build step and must be valid names for
1254 # Docker volumes. Each named volume must be used by at least two build steps.
1255 },
1256 ],
1257 "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
1258 "endTime": "A String", # End of time span.
1259 "startTime": "A String", # Start of time span.
1260 },
1261 "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's
1262 # builder image only.
1263 "endTime": "A String", # End of time span.
1264 "startTime": "A String", # Start of time span.
1265 },
1266 "id": "A String", # Unique identifier for this build step, used in `wait_for` to
1267 # reference this build step as a dependency.
1268 "dir": "A String", # Working directory to use when running this step's container.
1269 #
1270 # If this value is a relative path, it is relative to the build's working
1271 # directory. If this value is absolute, it may be outside the build's working
1272 # directory, in which case the contents of the path may not be persisted
1273 # across build step executions, unless a `volume` for that path is specified.
1274 #
1275 # If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
1276 # which specifies an absolute path, the `RepoSource` `dir` is ignored for
1277 # the step's execution.
1278 "name": "A String", # Required. The name of the container image that will run this particular
1279 # build step.
1280 #
1281 # If the image is available in the host's Docker daemon's cache, it
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1282 # will be run directly. If not, the host will attempt to pull the image
1283 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1284 #
1285 # The Docker daemon's cache will already have the latest versions of all of
1286 # the officially supported build steps
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1287 # ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
1288 # The Docker daemon will also have cached many of the layers for some popular
1289 # images, like "ubuntu", "debian", but they will be refreshed at the time you
1290 # attempt to use them.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1291 #
1292 # If you built an image in a previous build step, it will be stored in the
1293 # host's Docker daemon's cache and is available to use as the name for a
1294 # later build step.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1295 },
1296 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1297 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
1298 # granularity. If this amount of time elapses, work on the build will cease
1299 # and the build status will be `TIMEOUT`.
1300 #
1301 # Default time is ten minutes.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1302 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
1303 # [Bucket Name
1304 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1305 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1306 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
1307 "substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution
1308 # checks.
1309 "logging": "A String", # Option to specify the logging mode, which determines where the logs are
1310 # stored.
1311 "volumes": [ # Global list of volumes to mount for ALL build steps
1312 #
1313 # Each volume is created as an empty volume prior to starting the build
1314 # process. Upon completion of the build, volumes and their contents are
1315 # discarded. Global volume names and paths cannot conflict with the volumes
1316 # defined a build step.
1317 #
1318 # Using a global volume in a build with only one step is not valid as
1319 # it is indicative of a build request with an incorrect configuration.
1320 { # Volume describes a Docker container volume which is mounted into build steps
1321 # in order to persist files across build step execution.
1322 "path": "A String", # Path at which to mount the volume.
1323 #
1324 # Paths must be absolute and cannot conflict with other volume paths on the
1325 # same build step or with certain reserved volume paths.
1326 "name": "A String", # Name of the volume to mount.
1327 #
1328 # Volume names must be unique per build step and must be valid names for
1329 # Docker volumes. Each named volume must be used by at least two build steps.
1330 },
1331 ],
1332 "workerPool": "A String", # Option to specify a `WorkerPool` for the build. User specifies the pool
1333 # with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]".
1334 # This is an experimental field.
1335 "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
1336 # Storage.
1337 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
1338 "A String",
1339 ],
1340 "secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud
1341 # Key Management Service crypto key. These values must be specified in the
1342 # build's `Secret`. These variables will be available to all build steps
1343 # in this build.
1344 "A String",
1345 ],
1346 "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*
1347 # "disk free"; some of the space will be used by the operating system and
1348 # build utilities. Also note that this is the minimum disk size that will be
1349 # allocated for the build -- the build may run with a larger disk than
1350 # requested. At present, the maximum disk size is 1000GB; builds that request
1351 # more than the maximum are rejected with an error.
1352 "env": [ # A list of global environment variable definitions that will exist for all
1353 # build steps in this build. If a variable is defined in both globally and in
1354 # a build step, the variable will use the build step value.
1355 #
1356 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
1357 # being given the value "VALUE".
1358 "A String",
1359 ],
1360 "requestedVerifyOption": "A String", # Requested verifiability options.
1361 "machineType": "A String", # Compute Engine machine type on which to run the build.
1362 },
1363 "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1364 }</pre>
1365</div>
1366
1367<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1368 <code class="details" id="list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1369 <pre>Lists previously requested builds.
1370
1371Previously requested builds may still be in-progress, or may have finished
1372successfully or unsuccessfully.
1373
1374Args:
1375 projectId: string, ID of the project. (required)
1376 pageSize: integer, Number of results to return in the list.
1377 pageToken: string, Token to provide to skip to a particular spot in the list.
1378 x__xgafv: string, V1 error format.
1379 Allowed values
1380 1 - v1 error format
1381 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1382 filter: string, The raw filter text to constrain the results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1383
1384Returns:
1385 An object of the form:
1386
1387 { # Response including listed builds.
1388 "nextPageToken": "A String", # Token to receive the next page of results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1389 "builds": [ # Builds will be sorted by `create_time`, descending.
1390 { # A build resource in the Cloud Build API.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1391 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1392 # At a high level, a `Build` describes where to find source code, how to build
1393 # it (for example, the builder image to run on the source), and where to store
1394 # the built artifacts.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1395 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1396 # Fields can include the following variables, which will be expanded when the
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1397 # build is created:
1398 #
1399 # - $PROJECT_ID: the project ID of the build.
1400 # - $BUILD_ID: the autogenerated ID of the build.
1401 # - $REPO_NAME: the source repository name specified by RepoSource.
1402 # - $BRANCH_NAME: the branch name specified by RepoSource.
1403 # - $TAG_NAME: the tag name specified by RepoSource.
1404 # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
1405 # resolved from the specified branch or tag.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1406 # - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
1407 "results": { # Artifacts created by the build pipeline. # Output only. Results of the build.
1408 "buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order
1409 # corresponding to build step indices.
1410 #
1411 # [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)
1412 # can produce this output by writing to `$BUILDER_OUTPUT/output`.
1413 # Only the first 4KB of data is stored.
1414 "A String",
1415 ],
1416 "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts.
1417 "endTime": "A String", # End of time span.
1418 "startTime": "A String", # Start of time span.
1419 },
1420 "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.
1421 "images": [ # Container images that were built as a part of the build.
1422 { # An image built by the pipeline.
1423 "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.
1424 "endTime": "A String", # End of time span.
1425 "startTime": "A String", # Start of time span.
1426 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1427 "name": "A String", # Name used to push the container image to Google Container Registry, as
1428 # presented to `docker push`.
1429 "digest": "A String", # Docker Registry 2.0 digest.
1430 },
1431 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1432 "buildStepImages": [ # List of build step digests, in the order corresponding to build step
1433 # indices.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1434 "A String",
1435 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1436 "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1437 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1438 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.
1439 # some source was used for this build.
1440 "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any
1441 # revisions resolved.
1442 "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
1443 # project ID requesting the build is assumed.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1444 "commitSha": "A String", # Explicit commit SHA to build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1445 "repoName": "A String", # Name of the Cloud Source Repository. If omitted, the name "default" is
1446 # assumed.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1447 "tagName": "A String", # Name of the tag to build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1448 "branchName": "A String", # Name of the branch to build.
1449 "dir": "A String", # Directory, relative to the source root, in which to run the build.
1450 #
1451 # This must be a relative path. If a step's `dir` is specified and is an
1452 # absolute path, this value is ignored for that step's execution.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1453 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1454 "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that
1455 # the original source integrity was maintained in the build. Note that
1456 # `FileHashes` will only be populated if `BuildOptions` has requested a
1457 # `SourceProvenanceHash`.
1458 #
1459 # The keys to this map are file paths used as build source and the values
1460 # contain the hash values for those files.
1461 #
1462 # If the build source came in a single package such as a gzipped tarfile
1463 # (`.tar.gz`), the `FileHash` will be for the single path to that file.
1464 "a_key": { # Container message for hashes of byte content of files, used in
1465 # SourceProvenance messages to verify integrity of source input to the build.
1466 "fileHash": [ # Collection of file hashes.
1467 { # Container message for hash values.
1468 "type": "A String", # The type of hash that was performed.
1469 "value": "A String", # The hash value.
1470 },
1471 ],
1472 },
1473 },
1474 "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any
1475 # generations resolved.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1476 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1477 # omitted, the latest generation will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1478 "object": "A String", # Google Cloud Storage object containing the source.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1479 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1480 # This object must be a gzipped archive file (`.tar.gz`) containing source to
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1481 # build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1482 "bucket": "A String", # Google Cloud Storage bucket containing the source (see
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1483 # [Bucket Name
1484 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1485 },
1486 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1487 "images": [ # A list of images to be pushed upon the successful completion of all build
1488 # steps.
1489 #
1490 # The images are pushed using the builder service account's credentials.
1491 #
1492 # The digests of the pushed images will be stored in the `Build` resource's
1493 # results field.
1494 #
1495 # If any of the images fail to be pushed, the build status is marked
1496 # `FAILURE`.
1497 "A String",
1498 ],
1499 "id": "A String", # Output only. Unique identifier of the build.
1500 "artifacts": { # Artifacts produced by a build that should be uploaded upon # Artifacts produced by the build that should be uploaded upon
1501 # successful completion of all build steps.
1502 # successful completion of all build steps.
1503 "images": [ # A list of images to be pushed upon the successful completion of all build
1504 # steps.
1505 #
1506 # The images will be pushed using the builder service account's credentials.
1507 #
1508 # The digests of the pushed images will be stored in the Build resource's
1509 # results field.
1510 #
1511 # If any of the images fail to be pushed, the build is marked FAILURE.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1512 "A String",
1513 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1514 "objects": { # Files in the workspace to upload to Cloud Storage upon successful # A list of objects to be uploaded to Cloud Storage upon successful
1515 # completion of all build steps.
1516 #
1517 # Files in the workspace matching specified paths globs will be uploaded to
1518 # the specified Cloud Storage location using the builder service account's
1519 # credentials.
1520 #
1521 # The location and generation of the uploaded objects will be stored in the
1522 # Build resource's results field.
1523 #
1524 # If any objects fail to be pushed, the build is marked FAILURE.
1525 # completion of all build steps.
1526 "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.
1527 "endTime": "A String", # End of time span.
1528 "startTime": "A String", # Start of time span.
1529 },
1530 "paths": [ # Path globs used to match files in the build's workspace.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1531 "A String",
1532 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1533 "location": "A String", # Cloud Storage bucket and optional object path, in the form
1534 # "gs://bucket/path/to/somewhere/". (see [Bucket Name
1535 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1536 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1537 # Files in the workspace matching any path pattern will be uploaded to
1538 # Cloud Storage with this location as a prefix.
1539 },
1540 },
1541 "projectId": "A String", # Output only. ID of the project.
1542 "substitutions": { # Substitutions data for `Build` resource.
1543 "a_key": "A String",
1544 },
1545 "source": { # Location of the source in a supported storage service. # The location of the source files to build.
1546 "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source
1547 # Repository.
1548 "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the
1549 # project ID requesting the build is assumed.
1550 "commitSha": "A String", # Explicit commit SHA to build.
1551 "repoName": "A String", # Name of the Cloud Source Repository. If omitted, the name "default" is
1552 # assumed.
1553 "tagName": "A String", # Name of the tag to build.
1554 "branchName": "A String", # Name of the branch to build.
1555 "dir": "A String", # Directory, relative to the source root, in which to run the build.
1556 #
1557 # This must be a relative path. If a step's `dir` is specified and is an
1558 # absolute path, this value is ignored for that step's execution.
1559 },
1560 "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
1561 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1562 # omitted, the latest generation will be used.
1563 "object": "A String", # Google Cloud Storage object containing the source.
1564 #
1565 # This object must be a gzipped archive file (`.tar.gz`) containing source to
1566 # build.
1567 "bucket": "A String", # Google Cloud Storage bucket containing the source (see
1568 # [Bucket Name
1569 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1570 },
1571 },
1572 "status": "A String", # Output only. Status of the build.
1573 "tags": [ # Tags for annotation of a `Build`. These are not docker tags.
1574 "A String",
1575 ],
1576 "statusDetail": "A String", # Output only. Customer-readable message about the current status.
1577 "startTime": "A String", # Output only. Time at which execution of the build was started.
1578 "timing": { # Output only. Stores timing information for phases of the build. Valid keys
1579 # are:
1580 #
1581 # * BUILD: time to execute all build steps
1582 # * PUSH: time to push all specified images.
1583 # * FETCHSOURCE: time to fetch source.
1584 #
1585 # If the build does not specify source or images,
1586 # these keys will not be included.
1587 "a_key": { # Start and end times for a build execution phase.
1588 "endTime": "A String", # End of time span.
1589 "startTime": "A String", # Start of time span.
1590 },
1591 },
1592 "createTime": "A String", # Output only. Time at which the request to create the build was received.
1593 "finishTime": "A String", # Output only. Time at which execution of the build was finished.
1594 #
1595 # The difference between finish_time and start_time is the duration of the
1596 # build's execution.
1597 "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it
1598 # was triggered automatically.
1599 "secrets": [ # Secrets to decrypt using Cloud Key Management Service.
1600 { # Pairs a set of secret environment variables containing encrypted
1601 # values with the Cloud KMS key to use to decrypt the value.
1602 "secretEnv": { # Map of environment variable name to its encrypted value.
1603 #
1604 # Secret environment variables must be unique across all of a build's
1605 # secrets, and must be used by at least one build step. Values can be at most
1606 # 64 KB in size. There can be at most 100 secret values across all of a
1607 # build's secrets.
1608 "a_key": "A String",
1609 },
1610 "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.
1611 },
1612 ],
1613 "steps": [ # Required. The operations to be performed on the workspace.
1614 { # A step in the build pipeline.
1615 "status": "A String", # Output only. Status of the build step. At this time, build step status is
1616 # only updated on build completion; step status is not updated in real-time
1617 # as the build progresses.
1618 "args": [ # A list of arguments that will be presented to the step when it is started.
1619 #
1620 # If the image used to run the step's container has an entrypoint, the `args`
1621 # are used as arguments to that entrypoint. If the image does not define
1622 # an entrypoint, the first element in args is used as the entrypoint,
1623 # and the remainder will be used as arguments.
1624 "A String",
1625 ],
1626 "env": [ # A list of environment variable definitions to be used when running a step.
1627 #
1628 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
1629 # being given the value "VALUE".
1630 "A String",
1631 ],
1632 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
1633 # This build step will not start until all the build steps in `wait_for`
1634 # have completed successfully. If `wait_for` is empty, this build step will
1635 # start when all previous build steps in the `Build.Steps` list have
1636 # completed successfully.
1637 "A String",
1638 ],
1639 "timeout": "A String", # Time limit for executing this build step. If not defined, the step has no
1640 # time limit and will be allowed to continue to run until either it completes
1641 # or the build itself times out.
1642 "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key
1643 # Management Service crypto key. These values must be specified in the
1644 # build's `Secret`.
1645 "A String",
1646 ],
1647 "entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint.
1648 # If unset, the image's default entrypoint is used.
1649 "volumes": [ # List of volumes to mount into the build step.
1650 #
1651 # Each volume is created as an empty volume prior to execution of the
1652 # build step. Upon completion of the build, volumes and their contents are
1653 # discarded.
1654 #
1655 # Using a named volume in only one step is not valid as it is indicative
1656 # of a build request with an incorrect configuration.
1657 { # Volume describes a Docker container volume which is mounted into build steps
1658 # in order to persist files across build step execution.
1659 "path": "A String", # Path at which to mount the volume.
1660 #
1661 # Paths must be absolute and cannot conflict with other volume paths on the
1662 # same build step or with certain reserved volume paths.
1663 "name": "A String", # Name of the volume to mount.
1664 #
1665 # Volume names must be unique per build step and must be valid names for
1666 # Docker volumes. Each named volume must be used by at least two build steps.
1667 },
1668 ],
1669 "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.
1670 "endTime": "A String", # End of time span.
1671 "startTime": "A String", # Start of time span.
1672 },
1673 "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's
1674 # builder image only.
1675 "endTime": "A String", # End of time span.
1676 "startTime": "A String", # Start of time span.
1677 },
1678 "id": "A String", # Unique identifier for this build step, used in `wait_for` to
1679 # reference this build step as a dependency.
1680 "dir": "A String", # Working directory to use when running this step's container.
1681 #
1682 # If this value is a relative path, it is relative to the build's working
1683 # directory. If this value is absolute, it may be outside the build's working
1684 # directory, in which case the contents of the path may not be persisted
1685 # across build step executions, unless a `volume` for that path is specified.
1686 #
1687 # If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
1688 # which specifies an absolute path, the `RepoSource` `dir` is ignored for
1689 # the step's execution.
1690 "name": "A String", # Required. The name of the container image that will run this particular
1691 # build step.
1692 #
1693 # If the image is available in the host's Docker daemon's cache, it
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1694 # will be run directly. If not, the host will attempt to pull the image
1695 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1696 #
1697 # The Docker daemon's cache will already have the latest versions of all of
1698 # the officially supported build steps
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1699 # ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
1700 # The Docker daemon will also have cached many of the layers for some popular
1701 # images, like "ubuntu", "debian", but they will be refreshed at the time you
1702 # attempt to use them.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1703 #
1704 # If you built an image in a previous build step, it will be stored in the
1705 # host's Docker daemon's cache and is available to use as the name for a
1706 # later build step.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1707 },
1708 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1709 "timeout": "A String", # Amount of time that this build should be allowed to run, to second
1710 # granularity. If this amount of time elapses, work on the build will cease
1711 # and the build status will be `TIMEOUT`.
1712 #
1713 # Default time is ten minutes.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1714 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
1715 # [Bucket Name
1716 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1717 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1718 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
1719 "substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution
1720 # checks.
1721 "logging": "A String", # Option to specify the logging mode, which determines where the logs are
1722 # stored.
1723 "volumes": [ # Global list of volumes to mount for ALL build steps
1724 #
1725 # Each volume is created as an empty volume prior to starting the build
1726 # process. Upon completion of the build, volumes and their contents are
1727 # discarded. Global volume names and paths cannot conflict with the volumes
1728 # defined a build step.
1729 #
1730 # Using a global volume in a build with only one step is not valid as
1731 # it is indicative of a build request with an incorrect configuration.
1732 { # Volume describes a Docker container volume which is mounted into build steps
1733 # in order to persist files across build step execution.
1734 "path": "A String", # Path at which to mount the volume.
1735 #
1736 # Paths must be absolute and cannot conflict with other volume paths on the
1737 # same build step or with certain reserved volume paths.
1738 "name": "A String", # Name of the volume to mount.
1739 #
1740 # Volume names must be unique per build step and must be valid names for
1741 # Docker volumes. Each named volume must be used by at least two build steps.
1742 },
1743 ],
1744 "workerPool": "A String", # Option to specify a `WorkerPool` for the build. User specifies the pool
1745 # with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]".
1746 # This is an experimental field.
1747 "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud
1748 # Storage.
1749 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
1750 "A String",
1751 ],
1752 "secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud
1753 # Key Management Service crypto key. These values must be specified in the
1754 # build's `Secret`. These variables will be available to all build steps
1755 # in this build.
1756 "A String",
1757 ],
1758 "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*
1759 # "disk free"; some of the space will be used by the operating system and
1760 # build utilities. Also note that this is the minimum disk size that will be
1761 # allocated for the build -- the build may run with a larger disk than
1762 # requested. At present, the maximum disk size is 1000GB; builds that request
1763 # more than the maximum are rejected with an error.
1764 "env": [ # A list of global environment variable definitions that will exist for all
1765 # build steps in this build. If a variable is defined in both globally and in
1766 # a build step, the variable will use the build step value.
1767 #
1768 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
1769 # being given the value "VALUE".
1770 "A String",
1771 ],
1772 "requestedVerifyOption": "A String", # Requested verifiability options.
1773 "machineType": "A String", # Compute Engine machine type on which to run the build.
1774 },
1775 "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1776 },
1777 ],
1778 }</pre>
1779</div>
1780
1781<div class="method">
1782 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1783 <pre>Retrieves the next page of results.
1784
1785Args:
1786 previous_request: The request for the previous page. (required)
1787 previous_response: The response from the request for the previous page. (required)
1788
1789Returns:
1790 A request object that you can call 'execute()' on to request the next
1791 page. Returns None if there are no more items in the collection.
1792 </pre>
1793</div>
1794
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1795<div class="method">
1796 <code class="details" id="retry">retry(projectId, id, body=None, x__xgafv=None)</code>
1797 <pre>Creates a new build based on the specified build.
1798
1799This method creates a new build using the original build request, which may
1800or may not result in an identical build.
1801
1802For triggered builds:
1803
1804* Triggered builds resolve to a precise revision; therefore a retry of a
1805triggered build will result in a build that uses the same revision.
1806
1807For non-triggered builds that specify `RepoSource`:
1808
1809* If the original build built from the tip of a branch, the retried build
1810will build from the tip of that branch, which may not be the same revision
1811as the original build.
1812* If the original build specified a commit sha or revision ID, the retried
1813build will use the identical source.
1814
1815For builds that specify `StorageSource`:
1816
1817* If the original build pulled source from Google Cloud Storage without
1818specifying the generation of the object, the new build will use the current
1819object, which may be different from the original build source.
1820* If the original build pulled source from Cloud Storage and specified the
1821generation of the object, the new build will attempt to use the same
1822object, which may or may not be available depending on the bucket's
1823lifecycle management settings.
1824
1825Args:
1826 projectId: string, ID of the project. (required)
1827 id: string, Build ID of the original build. (required)
1828 body: object, The request body.
1829 The object takes the form of:
1830
1831{ # Specifies a build to retry.
1832 }
1833
1834 x__xgafv: string, V1 error format.
1835 Allowed values
1836 1 - v1 error format
1837 2 - v2 error format
1838
1839Returns:
1840 An object of the form:
1841
1842 { # This resource represents a long-running operation that is the result of a
1843 # network API call.
1844 "metadata": { # Service-specific metadata associated with the operation. It typically
1845 # contains progress information and common metadata such as create time.
1846 # Some services might not provide such metadata. Any method that returns a
1847 # long-running operation should document the metadata type, if any.
1848 "a_key": "", # Properties of the object. Contains field @type with type URL.
1849 },
1850 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
1851 # different programming environments, including REST APIs and RPC APIs. It is
1852 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1853 # three pieces of data: error code, error message, and error details.
1854 #
1855 # You can find out more about this error model and how to work with it in the
1856 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1857 "message": "A String", # A developer-facing error message, which should be in English. Any
1858 # user-facing error message should be localized and sent in the
1859 # google.rpc.Status.details field, or localized by the client.
1860 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1861 "details": [ # A list of messages that carry the error details. There is a common set of
1862 # message types for APIs to use.
1863 {
1864 "a_key": "", # Properties of the object. Contains field @type with type URL.
1865 },
1866 ],
1867 },
1868 "done": True or False, # If the value is `false`, it means the operation is still in progress.
1869 # If `true`, the operation is completed, and either `error` or `response` is
1870 # available.
1871 "response": { # The normal response of the operation in case of success. If the original
1872 # method returns no data on success, such as `Delete`, the response is
1873 # `google.protobuf.Empty`. If the original method is standard
1874 # `Get`/`Create`/`Update`, the response should be the resource. For other
1875 # methods, the response should have the type `XxxResponse`, where `Xxx`
1876 # is the original method name. For example, if the original method name
1877 # is `TakeSnapshot()`, the inferred response type is
1878 # `TakeSnapshotResponse`.
1879 "a_key": "", # Properties of the object. Contains field @type with type URL.
1880 },
1881 "name": "A String", # The server-assigned name, which is only unique within the same service that
1882 # originally returns it. If you use the default HTTP mapping, the
1883 # `name` should be a resource name ending with `operations/{unique_id}`.
1884 }</pre>
1885</div>
1886
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1887</body></html>