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