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