Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / cloudbuild_v1.projects.builds.html
blob: 3aa52c489ac6fb95a596021d59b00f1012017c88 [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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]163 "substitutions": { # Substitutions data for Build resource.
164 "a_key": "A String",
165 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]166 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
167 # service.
168 "storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
169 # Storage.
170 # Google Cloud Storage.
171 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
172 # omitted, the latest generation will be used.
173 "object": "A String", # Google Cloud Storage object containing source.
174 #
175 # This object must be a gzipped archive file (.tar.gz) containing source to
176 # build.
177 "bucket": "A String", # Google Cloud Storage bucket containing source (see
178 # [Bucket Name
179 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
180 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]181 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
182 # Repository.
183 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
184 # the build is assumed.
185 "branchName": "A String", # Name of the branch to build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]186 "commitSha": "A String", # Explicit commit SHA to build.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]187 "tagName": "A String", # Name of the tag to build.
188 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]189 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]190 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]191 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
192 # triggered automatically.
193 # @OutputOnly
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]194 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
195 "requestedVerifyOption": "A String", # Requested verifiability options.
196 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
197 "A String",
198 ],
199 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]200 "steps": [ # Describes the operations to be performed on the workspace.
201 { # BuildStep describes a step to perform in the build pipeline.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]202 "args": [ # A list of arguments that will be presented to the step when it is started.
203 #
204 # If the image used to run the step's container has an entrypoint, these args
205 # will be used as arguments to that entrypoint. If the image does not define
206 # an entrypoint, the first element in args will be used as the entrypoint,
207 # and the remainder will be used as arguments.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]208 "A String",
209 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]210 "name": "A String", # The name of the container image that will run this particular build step.
211 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]212 # If the image is already available in the host's Docker daemon's cache, it
213 # will be run directly. If not, the host will attempt to pull the image
214 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]215 #
216 # The Docker daemon's cache will already have the latest versions of all of
217 # the officially supported build steps
218 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
219 # will also have cached many of the layers for some popular images, like
220 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
221 # use them.
222 #
223 # If you built an image in a previous build step, it will be stored in the
224 # host's Docker daemon's cache and is available to use as the name for a
225 # later build step.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]226 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
227 # This build step will not start until all the build steps in wait_for
228 # have completed successfully. If wait_for is empty, this build step will
229 # start when all previous build steps in the Build.Steps list have completed
230 # successfully.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]231 "A String",
232 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]233 "entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
234 # If unset, the image's default will be used.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]235 "env": [ # A list of environment variable definitions to be used when running a step.
236 #
237 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
238 # being given the value "VALUE".
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]239 "A String",
240 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]241 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
242 # reference this build step as a dependency.
243 "dir": "A String", # Working directory (relative to project source root) to use when running
244 # this operation's container.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]245 },
246 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]247 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
248 # @OutputOnly
249 # some source was used for this build.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]250 "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
251 # generations resolved.
252 # Google Cloud Storage.
253 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
254 # omitted, the latest generation will be used.
255 "object": "A String", # Google Cloud Storage object containing source.
256 #
257 # This object must be a gzipped archive file (.tar.gz) containing source to
258 # build.
259 "bucket": "A String", # Google Cloud Storage bucket containing source (see
260 # [Bucket Name
261 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]262 },
263 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
264 # source integrity was maintained in the build. Note that FileHashes will
265 # only be populated if BuildOptions has requested a SourceProvenanceHash.
266 #
267 # The keys to this map are file paths used as build source and the values
268 # contain the hash values for those files.
269 #
270 # If the build source came in a single package such as a gzipped tarfile
271 # (.tar.gz), the FileHash will be for the single path to that file.
272 # @OutputOnly
273 "a_key": { # Container message for hashes of byte content of files, used in
274 # SourceProvenance messages to verify integrity of source input to the build.
275 "fileHash": [ # Collection of file hashes.
276 { # Container message for hash values.
277 "type": "A String", # The type of hash that was performed.
278 "value": "A String", # The hash value.
279 },
280 ],
281 },
282 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]283 "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
284 # revisions resolved.
285 # Repository.
286 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
287 # the build is assumed.
288 "branchName": "A String", # Name of the branch to build.
289 "commitSha": "A String", # Explicit commit SHA to build.
290 "tagName": "A String", # Name of the tag to build.
291 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]292 },
293 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]294 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
295 # [Bucket Name
296 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
297 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]298 "images": [ # A list of images to be pushed upon the successful completion of all build
299 # steps.
300 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]301 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]302 #
303 # The digests of the pushed images will be stored in the Build resource's
304 # results field.
305 #
306 # 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]307 "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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]378 "substitutions": { # Substitutions data for Build resource.
379 "a_key": "A String",
380 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]381 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
382 # service.
383 "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
384 # Storage.
385 # Google Cloud Storage.
386 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
387 # omitted, the latest generation will be used.
388 "object": "A String", # Google Cloud Storage object containing source.
389 #
390 # This object must be a gzipped archive file (.tar.gz) containing source to
391 # build.
392 "bucket": "A String", # Google Cloud Storage bucket containing source (see
393 # [Bucket Name
394 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
395 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]396 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
397 # Repository.
398 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
399 # the build is assumed.
400 "branchName": "A String", # Name of the branch to build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]401 "commitSha": "A String", # Explicit commit SHA to build.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]402 "tagName": "A String", # Name of the tag to build.
403 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]404 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]405 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]406 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
407 # triggered automatically.
408 # @OutputOnly
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]409 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
410 "requestedVerifyOption": "A String", # Requested verifiability options.
411 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
412 "A String",
413 ],
414 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]415 "steps": [ # Describes the operations to be performed on the workspace.
416 { # BuildStep describes a step to perform in the build pipeline.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]417 "args": [ # A list of arguments that will be presented to the step when it is started.
418 #
419 # If the image used to run the step's container has an entrypoint, these args
420 # will be used as arguments to that entrypoint. If the image does not define
421 # an entrypoint, the first element in args will be used as the entrypoint,
422 # and the remainder will be used as arguments.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]423 "A String",
424 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]425 "name": "A String", # The name of the container image that will run this particular build step.
426 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]427 # If the image is already available in the host's Docker daemon's cache, it
428 # will be run directly. If not, the host will attempt to pull the image
429 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]430 #
431 # The Docker daemon's cache will already have the latest versions of all of
432 # the officially supported build steps
433 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
434 # will also have cached many of the layers for some popular images, like
435 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
436 # use them.
437 #
438 # If you built an image in a previous build step, it will be stored in the
439 # host's Docker daemon's cache and is available to use as the name for a
440 # later build step.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]441 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
442 # This build step will not start until all the build steps in wait_for
443 # have completed successfully. If wait_for is empty, this build step will
444 # start when all previous build steps in the Build.Steps list have completed
445 # successfully.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]446 "A String",
447 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]448 "entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
449 # If unset, the image's default will be used.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]450 "env": [ # A list of environment variable definitions to be used when running a step.
451 #
452 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
453 # being given the value "VALUE".
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]454 "A String",
455 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]456 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
457 # reference this build step as a dependency.
458 "dir": "A String", # Working directory (relative to project source root) to use when running
459 # this operation's container.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]460 },
461 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]462 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
463 # @OutputOnly
464 # some source was used for this build.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]465 "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
466 # generations resolved.
467 # Google Cloud Storage.
468 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
469 # omitted, the latest generation will be used.
470 "object": "A String", # Google Cloud Storage object containing source.
471 #
472 # This object must be a gzipped archive file (.tar.gz) containing source to
473 # build.
474 "bucket": "A String", # Google Cloud Storage bucket containing source (see
475 # [Bucket Name
476 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]477 },
478 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
479 # source integrity was maintained in the build. Note that FileHashes will
480 # only be populated if BuildOptions has requested a SourceProvenanceHash.
481 #
482 # The keys to this map are file paths used as build source and the values
483 # contain the hash values for those files.
484 #
485 # If the build source came in a single package such as a gzipped tarfile
486 # (.tar.gz), the FileHash will be for the single path to that file.
487 # @OutputOnly
488 "a_key": { # Container message for hashes of byte content of files, used in
489 # SourceProvenance messages to verify integrity of source input to the build.
490 "fileHash": [ # Collection of file hashes.
491 { # Container message for hash values.
492 "type": "A String", # The type of hash that was performed.
493 "value": "A String", # The hash value.
494 },
495 ],
496 },
497 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]498 "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
499 # revisions resolved.
500 # Repository.
501 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
502 # the build is assumed.
503 "branchName": "A String", # Name of the branch to build.
504 "commitSha": "A String", # Explicit commit SHA to build.
505 "tagName": "A String", # Name of the tag to build.
506 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]507 },
508 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]509 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
510 # [Bucket Name
511 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
512 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]513 "images": [ # A list of images to be pushed upon the successful completion of all build
514 # steps.
515 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]516 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]517 #
518 # The digests of the pushed images will be stored in the Build resource's
519 # results field.
520 #
521 # 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]522 "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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]695 "substitutions": { # Substitutions data for Build resource.
696 "a_key": "A String",
697 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]698 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
699 # service.
700 "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
701 # Storage.
702 # Google Cloud Storage.
703 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
704 # omitted, the latest generation will be used.
705 "object": "A String", # Google Cloud Storage object containing source.
706 #
707 # This object must be a gzipped archive file (.tar.gz) containing source to
708 # build.
709 "bucket": "A String", # Google Cloud Storage bucket containing source (see
710 # [Bucket Name
711 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
712 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]713 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
714 # Repository.
715 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
716 # the build is assumed.
717 "branchName": "A String", # Name of the branch to build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]718 "commitSha": "A String", # Explicit commit SHA to build.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]719 "tagName": "A String", # Name of the tag to build.
720 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]721 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]722 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]723 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
724 # triggered automatically.
725 # @OutputOnly
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]726 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
727 "requestedVerifyOption": "A String", # Requested verifiability options.
728 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
729 "A String",
730 ],
731 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]732 "steps": [ # Describes the operations to be performed on the workspace.
733 { # BuildStep describes a step to perform in the build pipeline.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]734 "args": [ # A list of arguments that will be presented to the step when it is started.
735 #
736 # If the image used to run the step's container has an entrypoint, these args
737 # will be used as arguments to that entrypoint. If the image does not define
738 # an entrypoint, the first element in args will be used as the entrypoint,
739 # and the remainder will be used as arguments.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]740 "A String",
741 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]742 "name": "A String", # The name of the container image that will run this particular build step.
743 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]744 # If the image is already available in the host's Docker daemon's cache, it
745 # will be run directly. If not, the host will attempt to pull the image
746 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]747 #
748 # The Docker daemon's cache will already have the latest versions of all of
749 # the officially supported build steps
750 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
751 # will also have cached many of the layers for some popular images, like
752 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
753 # use them.
754 #
755 # If you built an image in a previous build step, it will be stored in the
756 # host's Docker daemon's cache and is available to use as the name for a
757 # later build step.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]758 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
759 # This build step will not start until all the build steps in wait_for
760 # have completed successfully. If wait_for is empty, this build step will
761 # start when all previous build steps in the Build.Steps list have completed
762 # successfully.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]763 "A String",
764 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]765 "entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
766 # If unset, the image's default will be used.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]767 "env": [ # A list of environment variable definitions to be used when running a step.
768 #
769 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
770 # being given the value "VALUE".
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]771 "A String",
772 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]773 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
774 # reference this build step as a dependency.
775 "dir": "A String", # Working directory (relative to project source root) to use when running
776 # this operation's container.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]777 },
778 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]779 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
780 # @OutputOnly
781 # some source was used for this build.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]782 "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
783 # generations resolved.
784 # Google Cloud Storage.
785 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
786 # omitted, the latest generation will be used.
787 "object": "A String", # Google Cloud Storage object containing source.
788 #
789 # This object must be a gzipped archive file (.tar.gz) containing source to
790 # build.
791 "bucket": "A String", # Google Cloud Storage bucket containing source (see
792 # [Bucket Name
793 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]794 },
795 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
796 # source integrity was maintained in the build. Note that FileHashes will
797 # only be populated if BuildOptions has requested a SourceProvenanceHash.
798 #
799 # The keys to this map are file paths used as build source and the values
800 # contain the hash values for those files.
801 #
802 # If the build source came in a single package such as a gzipped tarfile
803 # (.tar.gz), the FileHash will be for the single path to that file.
804 # @OutputOnly
805 "a_key": { # Container message for hashes of byte content of files, used in
806 # SourceProvenance messages to verify integrity of source input to the build.
807 "fileHash": [ # Collection of file hashes.
808 { # Container message for hash values.
809 "type": "A String", # The type of hash that was performed.
810 "value": "A String", # The hash value.
811 },
812 ],
813 },
814 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]815 "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
816 # revisions resolved.
817 # Repository.
818 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
819 # the build is assumed.
820 "branchName": "A String", # Name of the branch to build.
821 "commitSha": "A String", # Explicit commit SHA to build.
822 "tagName": "A String", # Name of the tag to build.
823 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]824 },
825 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]826 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
827 # [Bucket Name
828 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
829 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]830 "images": [ # A list of images to be pushed upon the successful completion of all build
831 # steps.
832 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]833 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]834 #
835 # The digests of the pushed images will be stored in the Build resource's
836 # results field.
837 #
838 # 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]839 "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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]920 "substitutions": { # Substitutions data for Build resource.
921 "a_key": "A String",
922 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]923 "source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
924 # service.
925 "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
926 # Storage.
927 # Google Cloud Storage.
928 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
929 # omitted, the latest generation will be used.
930 "object": "A String", # Google Cloud Storage object containing source.
931 #
932 # This object must be a gzipped archive file (.tar.gz) containing source to
933 # build.
934 "bucket": "A String", # Google Cloud Storage bucket containing source (see
935 # [Bucket Name
936 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
937 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]938 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
939 # Repository.
940 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
941 # the build is assumed.
942 "branchName": "A String", # Name of the branch to build.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]943 "commitSha": "A String", # Explicit commit SHA to build.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]944 "tagName": "A String", # Name of the tag to build.
945 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]946 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]947 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]948 "buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
949 # triggered automatically.
950 # @OutputOnly
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]951 "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
952 "requestedVerifyOption": "A String", # Requested verifiability options.
953 "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
954 "A String",
955 ],
956 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]957 "steps": [ # Describes the operations to be performed on the workspace.
958 { # BuildStep describes a step to perform in the build pipeline.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]959 "args": [ # A list of arguments that will be presented to the step when it is started.
960 #
961 # If the image used to run the step's container has an entrypoint, these args
962 # will be used as arguments to that entrypoint. If the image does not define
963 # an entrypoint, the first element in args will be used as the entrypoint,
964 # and the remainder will be used as arguments.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]965 "A String",
966 ],
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]967 "name": "A String", # The name of the container image that will run this particular build step.
968 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]969 # If the image is already available in the host's Docker daemon's cache, it
970 # will be run directly. If not, the host will attempt to pull the image
971 # first, using the builder service account's credentials if necessary.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]972 #
973 # The Docker daemon's cache will already have the latest versions of all of
974 # the officially supported build steps
975 # (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon
976 # will also have cached many of the layers for some popular images, like
977 # "ubuntu", "debian", but they will be refreshed at the time you attempt to
978 # use them.
979 #
980 # If you built an image in a previous build step, it will be stored in the
981 # host's Docker daemon's cache and is available to use as the name for a
982 # later build step.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]983 "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
984 # This build step will not start until all the build steps in wait_for
985 # have completed successfully. If wait_for is empty, this build step will
986 # start when all previous build steps in the Build.Steps list have completed
987 # successfully.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]988 "A String",
989 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]990 "entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
991 # If unset, the image's default will be used.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]992 "env": [ # A list of environment variable definitions to be used when running a step.
993 #
994 # The elements are of the form "KEY=VALUE" for the environment variable "KEY"
995 # being given the value "VALUE".
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]996 "A String",
997 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]998 "id": "A String", # Optional unique identifier for this build step, used in wait_for to
999 # reference this build step as a dependency.
1000 "dir": "A String", # Working directory (relative to project source root) to use when running
1001 # this operation's container.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1002 },
1003 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1004 "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
1005 # @OutputOnly
1006 # some source was used for this build.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1007 "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
1008 # generations resolved.
1009 # Google Cloud Storage.
1010 "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
1011 # omitted, the latest generation will be used.
1012 "object": "A String", # Google Cloud Storage object containing source.
1013 #
1014 # This object must be a gzipped archive file (.tar.gz) containing source to
1015 # build.
1016 "bucket": "A String", # Google Cloud Storage bucket containing source (see
1017 # [Bucket Name
1018 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1019 },
1020 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
1021 # source integrity was maintained in the build. Note that FileHashes will
1022 # only be populated if BuildOptions has requested a SourceProvenanceHash.
1023 #
1024 # The keys to this map are file paths used as build source and the values
1025 # contain the hash values for those files.
1026 #
1027 # If the build source came in a single package such as a gzipped tarfile
1028 # (.tar.gz), the FileHash will be for the single path to that file.
1029 # @OutputOnly
1030 "a_key": { # Container message for hashes of byte content of files, used in
1031 # SourceProvenance messages to verify integrity of source input to the build.
1032 "fileHash": [ # Collection of file hashes.
1033 { # Container message for hash values.
1034 "type": "A String", # The type of hash that was performed.
1035 "value": "A String", # The hash value.
1036 },
1037 ],
1038 },
1039 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1040 "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
1041 # revisions resolved.
1042 # Repository.
1043 "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
1044 # the build is assumed.
1045 "branchName": "A String", # Name of the branch to build.
1046 "commitSha": "A String", # Explicit commit SHA to build.
1047 "tagName": "A String", # Name of the tag to build.
1048 "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1049 },
1050 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1051 "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
1052 # [Bucket Name
1053 # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
1054 # Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1055 "images": [ # A list of images to be pushed upon the successful completion of all build
1056 # steps.
1057 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1058 # The images will be pushed using the builder service account's credentials.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1059 #
1060 # The digests of the pushed images will be stored in the Build resource's
1061 # results field.
1062 #
1063 # 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]1064 "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>