| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 75 | <h1><a href="cloudbuild_v1.html">Cloud Build API</a> . <a href="cloudbuild_v1.projects.html">projects</a> . <a href="cloudbuild_v1.projects.builds.html">builds</a></h1> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 78 | <code><a href="#cancel">cancel(projectId, id, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Cancels a build in progress.</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 81 | <code><a href="#close">close()</a></code></p> |
| 82 | <p class="firstline">Close httplib2 connections.</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 84 | <code><a href="#create">create(projectId, body=None, parent=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 87 | <code><a href="#get">get(projectId, id, name=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.</p> |
| 89 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 90 | <code><a href="#list">list(projectId, parent=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <p class="firstline">Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | <p class="toc_element"> |
| 96 | <code><a href="#retry">retry(projectId, id, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 97 | <p class="firstline">Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <code class="details" id="cancel">cancel(projectId, id, body=None, x__xgafv=None)</code> |
| 101 | <pre>Cancels a build in progress. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 102 | |
| 103 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 104 | projectId: string, Required. ID of the project. (required) |
| 105 | id: string, Required. ID of the build. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | body: object, The request body. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 107 | The object takes the form of: |
| 108 | |
| 109 | { # Request to cancel an ongoing build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 110 | "projectId": "A String", # Required. ID of the project. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 111 | "id": "A String", # Required. ID of the build. |
| 112 | "name": "A String", # The name of the `Build` to retrieve. Format: `projects/{project}/locations/{location}/builds/{build}` |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 113 | } |
| 114 | |
| 115 | x__xgafv: string, V1 error format. |
| 116 | Allowed values |
| 117 | 1 - v1 error format |
| 118 | 2 - v2 error format |
| 119 | |
| 120 | Returns: |
| 121 | An object of the form: |
| 122 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 123 | { # A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 124 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 125 | "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. |
| 126 | "A String", |
| 127 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 128 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 129 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 130 | "volumes": [ # Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. |
| 131 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 132 | "path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
| 133 | "name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 134 | }, |
| 135 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 136 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 137 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 138 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 139 | "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
| 140 | "A String", |
| 141 | ], |
| 142 | "secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. |
| 143 | "A String", |
| 144 | ], |
| 145 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 146 | "A String", |
| 147 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 148 | "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 149 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 150 | "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. |
| 151 | "substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 152 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 153 | "queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. |
| 154 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| 155 | "steps": [ # Required. The operations to be performed on the workspace. |
| 156 | { # A step in the build pipeline. |
| 157 | "args": [ # A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. |
| 158 | "A String", |
| 159 | ], |
| 160 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 161 | "entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. |
| 162 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 163 | "startTime": "A String", # Start of time span. |
| 164 | "endTime": "A String", # End of time span. |
| 165 | }, |
| 166 | "timeout": "A String", # Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. |
| 167 | "volumes": [ # List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. |
| 168 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 169 | "path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
| 170 | "name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
| 171 | }, |
| 172 | ], |
| 173 | "env": [ # A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
| 174 | "A String", |
| 175 | ], |
| 176 | "name": "A String", # Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. |
| 177 | "dir": "A String", # Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. |
| 178 | "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. |
| 179 | "A String", |
| 180 | ], |
| 181 | "status": "A String", # Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. |
| 182 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. |
| 183 | "A String", |
| 184 | ], |
| 185 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 186 | "startTime": "A String", # Start of time span. |
| 187 | "endTime": "A String", # End of time span. |
| 188 | }, |
| 189 | }, |
| 190 | ], |
| 191 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 192 | "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. |
| 193 | "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. |
| 194 | "A String", |
| 195 | ], |
| 196 | "objects": { # Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. # A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. |
| 197 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 198 | "startTime": "A String", # Start of time span. |
| 199 | "endTime": "A String", # End of time span. |
| 200 | }, |
| 201 | "paths": [ # Path globs used to match files in the build's workspace. |
| 202 | "A String", |
| 203 | ], |
| 204 | "location": "A String", # Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. |
| 205 | }, |
| 206 | }, |
| 207 | "substitutions": { # Substitutions data for `Build` resource. |
| 208 | "a_key": "A String", |
| 209 | }, |
| 210 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source. |
| 211 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 212 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 213 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 214 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 215 | }, |
| 216 | "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. |
| 217 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 218 | "fileHash": [ # Collection of file hashes. |
| 219 | { # Container message for hash values. |
| 220 | "value": "A String", # The hash value. |
| 221 | "type": "A String", # The type of hash that was performed. |
| 222 | }, |
| 223 | ], |
| 224 | }, |
| 225 | }, |
| 226 | "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved. |
| 227 | "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 228 | "repoName": "A String", # Required. Name of the Cloud Source Repository. |
| 229 | "commitSha": "A String", # Explicit commit SHA to build. |
| 230 | "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. |
| 231 | "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 232 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 233 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 234 | "a_key": "A String", |
| 235 | }, |
| 236 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| 237 | }, |
| 238 | }, |
| 239 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 240 | "id": "A String", # Output only. Unique identifier of the build. |
| 241 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. |
| 242 | "serviceAccount": "A String", # IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. This field is in alpha and is not publicly available. |
| 243 | "finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. |
| 244 | "timing": { # Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 245 | "a_key": { # Start and end times for a build execution phase. |
| 246 | "startTime": "A String", # Start of time span. |
| 247 | "endTime": "A String", # End of time span. |
| 248 | }, |
| 249 | }, |
| 250 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 251 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 252 | "startTime": "A String", # Start of time span. |
| 253 | "endTime": "A String", # End of time span. |
| 254 | }, |
| 255 | "images": [ # Container images that were built as a part of the build. |
| 256 | { # An image built by the pipeline. |
| 257 | "digest": "A String", # Docker Registry 2.0 digest. |
| 258 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 259 | "startTime": "A String", # Start of time span. |
| 260 | "endTime": "A String", # End of time span. |
| 261 | }, |
| 262 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 263 | }, |
| 264 | ], |
| 265 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 266 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 267 | "A String", |
| 268 | ], |
| 269 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 270 | "buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. |
| 271 | "A String", |
| 272 | ], |
| 273 | }, |
| 274 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 275 | "projectId": "A String", # Output only. ID of the project. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 276 | "secrets": [ # Secrets to decrypt using Cloud Key Management Service. |
| 277 | { # Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. |
| 278 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 279 | "secretEnv": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. |
| 280 | "a_key": "A String", |
| 281 | }, |
| 282 | }, |
| 283 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 284 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 285 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 286 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 287 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 288 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 289 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 290 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 291 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 292 | "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 293 | "repoName": "A String", # Required. Name of the Cloud Source Repository. |
| 294 | "commitSha": "A String", # Explicit commit SHA to build. |
| 295 | "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 296 | "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 297 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 298 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 299 | "a_key": "A String", |
| 300 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 301 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 302 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 303 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 304 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| 305 | "A String", |
| 306 | ], |
| 307 | "status": "A String", # Output only. Status of the build. |
| 308 | "name": "A String", # Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 309 | }</pre> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 310 | </div> |
| 311 | |
| 312 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 313 | <code class="details" id="close">close()</code> |
| 314 | <pre>Close httplib2 connections.</pre> |
| 315 | </div> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 316 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 317 | <div class="method"> |
| 318 | <code class="details" id="create">create(projectId, body=None, parent=None, x__xgafv=None)</code> |
| 319 | <pre>Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 320 | |
| 321 | Args: |
| 322 | projectId: string, Required. ID of the project. (required) |
| 323 | body: object, The request body. |
| 324 | The object takes the form of: |
| 325 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 326 | { # A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 327 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 328 | "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. |
| 329 | "A String", |
| 330 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 331 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 332 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 333 | "volumes": [ # Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. |
| 334 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 335 | "path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
| 336 | "name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 337 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 338 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 339 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 340 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 341 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 342 | "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
| 343 | "A String", |
| 344 | ], |
| 345 | "secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. |
| 346 | "A String", |
| 347 | ], |
| 348 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 349 | "A String", |
| 350 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 351 | "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 352 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 353 | "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. |
| 354 | "substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 355 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 356 | "queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. |
| 357 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| 358 | "steps": [ # Required. The operations to be performed on the workspace. |
| 359 | { # A step in the build pipeline. |
| 360 | "args": [ # A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. |
| 361 | "A String", |
| 362 | ], |
| 363 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 364 | "entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. |
| 365 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 366 | "startTime": "A String", # Start of time span. |
| 367 | "endTime": "A String", # End of time span. |
| 368 | }, |
| 369 | "timeout": "A String", # Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. |
| 370 | "volumes": [ # List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. |
| 371 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 372 | "path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
| 373 | "name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
| 374 | }, |
| 375 | ], |
| 376 | "env": [ # A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
| 377 | "A String", |
| 378 | ], |
| 379 | "name": "A String", # Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. |
| 380 | "dir": "A String", # Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. |
| 381 | "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. |
| 382 | "A String", |
| 383 | ], |
| 384 | "status": "A String", # Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. |
| 385 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. |
| 386 | "A String", |
| 387 | ], |
| 388 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 389 | "startTime": "A String", # Start of time span. |
| 390 | "endTime": "A String", # End of time span. |
| 391 | }, |
| 392 | }, |
| 393 | ], |
| 394 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 395 | "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. |
| 396 | "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. |
| 397 | "A String", |
| 398 | ], |
| 399 | "objects": { # Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. # A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. |
| 400 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 401 | "startTime": "A String", # Start of time span. |
| 402 | "endTime": "A String", # End of time span. |
| 403 | }, |
| 404 | "paths": [ # Path globs used to match files in the build's workspace. |
| 405 | "A String", |
| 406 | ], |
| 407 | "location": "A String", # Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. |
| 408 | }, |
| 409 | }, |
| 410 | "substitutions": { # Substitutions data for `Build` resource. |
| 411 | "a_key": "A String", |
| 412 | }, |
| 413 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source. |
| 414 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 415 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 416 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 417 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 418 | }, |
| 419 | "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. |
| 420 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 421 | "fileHash": [ # Collection of file hashes. |
| 422 | { # Container message for hash values. |
| 423 | "value": "A String", # The hash value. |
| 424 | "type": "A String", # The type of hash that was performed. |
| 425 | }, |
| 426 | ], |
| 427 | }, |
| 428 | }, |
| 429 | "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved. |
| 430 | "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 431 | "repoName": "A String", # Required. Name of the Cloud Source Repository. |
| 432 | "commitSha": "A String", # Explicit commit SHA to build. |
| 433 | "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. |
| 434 | "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 435 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 436 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 437 | "a_key": "A String", |
| 438 | }, |
| 439 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| 440 | }, |
| 441 | }, |
| 442 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 443 | "id": "A String", # Output only. Unique identifier of the build. |
| 444 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. |
| 445 | "serviceAccount": "A String", # IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. This field is in alpha and is not publicly available. |
| 446 | "finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. |
| 447 | "timing": { # Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 448 | "a_key": { # Start and end times for a build execution phase. |
| 449 | "startTime": "A String", # Start of time span. |
| 450 | "endTime": "A String", # End of time span. |
| 451 | }, |
| 452 | }, |
| 453 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 454 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 455 | "startTime": "A String", # Start of time span. |
| 456 | "endTime": "A String", # End of time span. |
| 457 | }, |
| 458 | "images": [ # Container images that were built as a part of the build. |
| 459 | { # An image built by the pipeline. |
| 460 | "digest": "A String", # Docker Registry 2.0 digest. |
| 461 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 462 | "startTime": "A String", # Start of time span. |
| 463 | "endTime": "A String", # End of time span. |
| 464 | }, |
| 465 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 466 | }, |
| 467 | ], |
| 468 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 469 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 470 | "A String", |
| 471 | ], |
| 472 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 473 | "buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. |
| 474 | "A String", |
| 475 | ], |
| 476 | }, |
| 477 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 478 | "projectId": "A String", # Output only. ID of the project. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 479 | "secrets": [ # Secrets to decrypt using Cloud Key Management Service. |
| 480 | { # Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. |
| 481 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 482 | "secretEnv": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. |
| 483 | "a_key": "A String", |
| 484 | }, |
| 485 | }, |
| 486 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 487 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 488 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 489 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 490 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 491 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 492 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 493 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 494 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 495 | "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 496 | "repoName": "A String", # Required. Name of the Cloud Source Repository. |
| 497 | "commitSha": "A String", # Explicit commit SHA to build. |
| 498 | "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 499 | "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 500 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 501 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 502 | "a_key": "A String", |
| 503 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 504 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 505 | }, |
| 506 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 507 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| 508 | "A String", |
| 509 | ], |
| 510 | "status": "A String", # Output only. Status of the build. |
| 511 | "name": "A String", # Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 512 | } |
| 513 | |
| 514 | parent: string, The parent resource where this build will be created. Format: `projects/{project}/locations/{location}` |
| 515 | x__xgafv: string, V1 error format. |
| 516 | Allowed values |
| 517 | 1 - v1 error format |
| 518 | 2 - v2 error format |
| 519 | |
| 520 | Returns: |
| 521 | An object of the form: |
| 522 | |
| 523 | { # This resource represents a long-running operation that is the result of a network API call. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 524 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 525 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 526 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 527 | }, |
| 528 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 529 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 530 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 531 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 532 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 533 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 534 | { |
| 535 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 536 | }, |
| 537 | ], |
| 538 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 539 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 540 | }, |
| 541 | }</pre> |
| 542 | </div> |
| 543 | |
| 544 | <div class="method"> |
| 545 | <code class="details" id="get">get(projectId, id, name=None, x__xgafv=None)</code> |
| 546 | <pre>Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. |
| 547 | |
| 548 | Args: |
| 549 | projectId: string, Required. ID of the project. (required) |
| 550 | id: string, Required. ID of the build. (required) |
| 551 | name: string, The name of the `Build` to retrieve. Format: `projects/{project}/locations/{location}/builds/{build}` |
| 552 | x__xgafv: string, V1 error format. |
| 553 | Allowed values |
| 554 | 1 - v1 error format |
| 555 | 2 - v2 error format |
| 556 | |
| 557 | Returns: |
| 558 | An object of the form: |
| 559 | |
| 560 | { # A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 561 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 562 | "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. |
| 563 | "A String", |
| 564 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 565 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 566 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 567 | "volumes": [ # Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. |
| 568 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 569 | "path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
| 570 | "name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
| 571 | }, |
| 572 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 573 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 574 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 575 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 576 | "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
| 577 | "A String", |
| 578 | ], |
| 579 | "secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. |
| 580 | "A String", |
| 581 | ], |
| 582 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 583 | "A String", |
| 584 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 585 | "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 586 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 587 | "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. |
| 588 | "substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 589 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 590 | "queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. |
| 591 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| 592 | "steps": [ # Required. The operations to be performed on the workspace. |
| 593 | { # A step in the build pipeline. |
| 594 | "args": [ # A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. |
| 595 | "A String", |
| 596 | ], |
| 597 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 598 | "entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. |
| 599 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 600 | "startTime": "A String", # Start of time span. |
| 601 | "endTime": "A String", # End of time span. |
| 602 | }, |
| 603 | "timeout": "A String", # Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. |
| 604 | "volumes": [ # List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. |
| 605 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 606 | "path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
| 607 | "name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
| 608 | }, |
| 609 | ], |
| 610 | "env": [ # A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
| 611 | "A String", |
| 612 | ], |
| 613 | "name": "A String", # Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. |
| 614 | "dir": "A String", # Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. |
| 615 | "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. |
| 616 | "A String", |
| 617 | ], |
| 618 | "status": "A String", # Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. |
| 619 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. |
| 620 | "A String", |
| 621 | ], |
| 622 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 623 | "startTime": "A String", # Start of time span. |
| 624 | "endTime": "A String", # End of time span. |
| 625 | }, |
| 626 | }, |
| 627 | ], |
| 628 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 629 | "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. |
| 630 | "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. |
| 631 | "A String", |
| 632 | ], |
| 633 | "objects": { # Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. # A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. |
| 634 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 635 | "startTime": "A String", # Start of time span. |
| 636 | "endTime": "A String", # End of time span. |
| 637 | }, |
| 638 | "paths": [ # Path globs used to match files in the build's workspace. |
| 639 | "A String", |
| 640 | ], |
| 641 | "location": "A String", # Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. |
| 642 | }, |
| 643 | }, |
| 644 | "substitutions": { # Substitutions data for `Build` resource. |
| 645 | "a_key": "A String", |
| 646 | }, |
| 647 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source. |
| 648 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 649 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 650 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 651 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 652 | }, |
| 653 | "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. |
| 654 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 655 | "fileHash": [ # Collection of file hashes. |
| 656 | { # Container message for hash values. |
| 657 | "value": "A String", # The hash value. |
| 658 | "type": "A String", # The type of hash that was performed. |
| 659 | }, |
| 660 | ], |
| 661 | }, |
| 662 | }, |
| 663 | "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved. |
| 664 | "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 665 | "repoName": "A String", # Required. Name of the Cloud Source Repository. |
| 666 | "commitSha": "A String", # Explicit commit SHA to build. |
| 667 | "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. |
| 668 | "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 669 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 670 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 671 | "a_key": "A String", |
| 672 | }, |
| 673 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| 674 | }, |
| 675 | }, |
| 676 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 677 | "id": "A String", # Output only. Unique identifier of the build. |
| 678 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. |
| 679 | "serviceAccount": "A String", # IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. This field is in alpha and is not publicly available. |
| 680 | "finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. |
| 681 | "timing": { # Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 682 | "a_key": { # Start and end times for a build execution phase. |
| 683 | "startTime": "A String", # Start of time span. |
| 684 | "endTime": "A String", # End of time span. |
| 685 | }, |
| 686 | }, |
| 687 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 688 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 689 | "startTime": "A String", # Start of time span. |
| 690 | "endTime": "A String", # End of time span. |
| 691 | }, |
| 692 | "images": [ # Container images that were built as a part of the build. |
| 693 | { # An image built by the pipeline. |
| 694 | "digest": "A String", # Docker Registry 2.0 digest. |
| 695 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 696 | "startTime": "A String", # Start of time span. |
| 697 | "endTime": "A String", # End of time span. |
| 698 | }, |
| 699 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 700 | }, |
| 701 | ], |
| 702 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 703 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 704 | "A String", |
| 705 | ], |
| 706 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 707 | "buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. |
| 708 | "A String", |
| 709 | ], |
| 710 | }, |
| 711 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 712 | "projectId": "A String", # Output only. ID of the project. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 713 | "secrets": [ # Secrets to decrypt using Cloud Key Management Service. |
| 714 | { # Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. |
| 715 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 716 | "secretEnv": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. |
| 717 | "a_key": "A String", |
| 718 | }, |
| 719 | }, |
| 720 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 721 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 722 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 723 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 724 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 725 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 726 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 727 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 728 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 729 | "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 730 | "repoName": "A String", # Required. Name of the Cloud Source Repository. |
| 731 | "commitSha": "A String", # Explicit commit SHA to build. |
| 732 | "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 733 | "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 734 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 735 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 736 | "a_key": "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 737 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 738 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 739 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 740 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 741 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| 742 | "A String", |
| 743 | ], |
| 744 | "status": "A String", # Output only. Status of the build. |
| 745 | "name": "A String", # Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 746 | }</pre> |
| 747 | </div> |
| 748 | |
| 749 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 750 | <code class="details" id="list">list(projectId, parent=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 751 | <pre>Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 752 | |
| 753 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 754 | projectId: string, Required. ID of the project. (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 755 | parent: string, The parent of the collection of `Builds`. Format: `projects/{project}/locations/location` |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 756 | filter: string, The raw filter text to constrain the results. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 757 | pageToken: string, The page token for the next page of Builds. If unspecified, the first page of results is returned. If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results. See https://google.aip.dev/158 for more. |
| 758 | pageSize: integer, Number of results to return in the list. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 759 | x__xgafv: string, V1 error format. |
| 760 | Allowed values |
| 761 | 1 - v1 error format |
| 762 | 2 - v2 error format |
| 763 | |
| 764 | Returns: |
| 765 | An object of the form: |
| 766 | |
| 767 | { # Response including listed builds. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 768 | "nextPageToken": "A String", # Token to receive the next page of results. This will be absent if the end of the response list has been reached. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 769 | "builds": [ # Builds will be sorted by `create_time`, descending. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 770 | { # A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 771 | "logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 772 | "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. |
| 773 | "A String", |
| 774 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 775 | "options": { # Optional arguments to enable specific features of builds. # Special options for this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 776 | "workerPool": "A String", # Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 777 | "volumes": [ # Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. |
| 778 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 779 | "path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
| 780 | "name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
| 781 | }, |
| 782 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 783 | "requestedVerifyOption": "A String", # Requested verifiability options. |
| 784 | "logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud Storage. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 785 | "machineType": "A String", # Compute Engine machine type on which to run the build. |
| 786 | "env": [ # A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
| 787 | "A String", |
| 788 | ], |
| 789 | "secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. |
| 790 | "A String", |
| 791 | ], |
| 792 | "sourceProvenanceHash": [ # Requested hash for SourceProvenance. |
| 793 | "A String", |
| 794 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 795 | "diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 796 | "logging": "A String", # Option to specify the logging mode, which determines if and where build logs are stored. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 797 | "dynamicSubstitutions": True or False, # Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. |
| 798 | "substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 799 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 800 | "queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. |
| 801 | "buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. |
| 802 | "steps": [ # Required. The operations to be performed on the workspace. |
| 803 | { # A step in the build pipeline. |
| 804 | "args": [ # A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. |
| 805 | "A String", |
| 806 | ], |
| 807 | "id": "A String", # Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. |
| 808 | "entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. |
| 809 | "pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's builder image only. |
| 810 | "startTime": "A String", # Start of time span. |
| 811 | "endTime": "A String", # End of time span. |
| 812 | }, |
| 813 | "timeout": "A String", # Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. |
| 814 | "volumes": [ # List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. |
| 815 | { # Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. |
| 816 | "path": "A String", # Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. |
| 817 | "name": "A String", # Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. |
| 818 | }, |
| 819 | ], |
| 820 | "env": [ # A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". |
| 821 | "A String", |
| 822 | ], |
| 823 | "name": "A String", # Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. |
| 824 | "dir": "A String", # Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. |
| 825 | "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. |
| 826 | "A String", |
| 827 | ], |
| 828 | "status": "A String", # Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. |
| 829 | "waitFor": [ # The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. |
| 830 | "A String", |
| 831 | ], |
| 832 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step. |
| 833 | "startTime": "A String", # Start of time span. |
| 834 | "endTime": "A String", # End of time span. |
| 835 | }, |
| 836 | }, |
| 837 | ], |
| 838 | "logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console. |
| 839 | "artifacts": { # Artifacts produced by a build that should be uploaded upon successful completion of all build steps. # Artifacts produced by the build that should be uploaded upon successful completion of all build steps. |
| 840 | "images": [ # A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. |
| 841 | "A String", |
| 842 | ], |
| 843 | "objects": { # Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. # A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. |
| 844 | "timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects. |
| 845 | "startTime": "A String", # Start of time span. |
| 846 | "endTime": "A String", # End of time span. |
| 847 | }, |
| 848 | "paths": [ # Path globs used to match files in the build's workspace. |
| 849 | "A String", |
| 850 | ], |
| 851 | "location": "A String", # Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. |
| 852 | }, |
| 853 | }, |
| 854 | "substitutions": { # Substitutions data for `Build` resource. |
| 855 | "a_key": "A String", |
| 856 | }, |
| 857 | "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source. |
| 858 | "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved. |
| 859 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 860 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 861 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 862 | }, |
| 863 | "fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. |
| 864 | "a_key": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. |
| 865 | "fileHash": [ # Collection of file hashes. |
| 866 | { # Container message for hash values. |
| 867 | "value": "A String", # The hash value. |
| 868 | "type": "A String", # The type of hash that was performed. |
| 869 | }, |
| 870 | ], |
| 871 | }, |
| 872 | }, |
| 873 | "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved. |
| 874 | "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 875 | "repoName": "A String", # Required. Name of the Cloud Source Repository. |
| 876 | "commitSha": "A String", # Explicit commit SHA to build. |
| 877 | "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. |
| 878 | "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 879 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| 880 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 881 | "a_key": "A String", |
| 882 | }, |
| 883 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| 884 | }, |
| 885 | }, |
| 886 | "startTime": "A String", # Output only. Time at which execution of the build was started. |
| 887 | "id": "A String", # Output only. Unique identifier of the build. |
| 888 | "timeout": "A String", # Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is ten minutes. |
| 889 | "serviceAccount": "A String", # IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. This field is in alpha and is not publicly available. |
| 890 | "finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. |
| 891 | "timing": { # Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. |
| 892 | "a_key": { # Start and end times for a build execution phase. |
| 893 | "startTime": "A String", # Start of time span. |
| 894 | "endTime": "A String", # End of time span. |
| 895 | }, |
| 896 | }, |
| 897 | "results": { # Artifacts created by the build pipeline. # Output only. Results of the build. |
| 898 | "artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts. |
| 899 | "startTime": "A String", # Start of time span. |
| 900 | "endTime": "A String", # End of time span. |
| 901 | }, |
| 902 | "images": [ # Container images that were built as a part of the build. |
| 903 | { # An image built by the pipeline. |
| 904 | "digest": "A String", # Docker Registry 2.0 digest. |
| 905 | "pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image. |
| 906 | "startTime": "A String", # Start of time span. |
| 907 | "endTime": "A String", # End of time span. |
| 908 | }, |
| 909 | "name": "A String", # Name used to push the container image to Google Container Registry, as presented to `docker push`. |
| 910 | }, |
| 911 | ], |
| 912 | "numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded. |
| 913 | "buildStepImages": [ # List of build step digests, in the order corresponding to build step indices. |
| 914 | "A String", |
| 915 | ], |
| 916 | "artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded. |
| 917 | "buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. |
| 918 | "A String", |
| 919 | ], |
| 920 | }, |
| 921 | "statusDetail": "A String", # Output only. Customer-readable message about the current status. |
| 922 | "projectId": "A String", # Output only. ID of the project. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 923 | "secrets": [ # Secrets to decrypt using Cloud Key Management Service. |
| 924 | { # Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. |
| 925 | "kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs. |
| 926 | "secretEnv": { # Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. |
| 927 | "a_key": "A String", |
| 928 | }, |
| 929 | }, |
| 930 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 931 | "createTime": "A String", # Output only. Time at which the request to create the build was received. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 932 | "source": { # Location of the source in a supported storage service. # The location of the source files to build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 933 | "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage. |
| 934 | "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. |
| 935 | "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. |
| 936 | "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 937 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 938 | "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository. |
| 939 | "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| 940 | "repoName": "A String", # Required. Name of the Cloud Source Repository. |
| 941 | "commitSha": "A String", # Explicit commit SHA to build. |
| 942 | "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 943 | "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 944 | "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 945 | "substitutions": { # Substitutions to use in a triggered build. Should only be used with RunBuildTrigger |
| 946 | "a_key": "A String", |
| 947 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 948 | "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 949 | }, |
| 950 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 951 | "tags": [ # Tags for annotation of a `Build`. These are not docker tags. |
| 952 | "A String", |
| 953 | ], |
| 954 | "status": "A String", # Output only. Status of the build. |
| 955 | "name": "A String", # Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 956 | }, |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 957 | ], |
| 958 | }</pre> |
| 959 | </div> |
| 960 | |
| 961 | <div class="method"> |
| 962 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 963 | <pre>Retrieves the next page of results. |
| 964 | |
| 965 | Args: |
| 966 | previous_request: The request for the previous page. (required) |
| 967 | previous_response: The response from the request for the previous page. (required) |
| 968 | |
| 969 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 970 | A request object that you can call 'execute()' on to request the next |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 971 | page. Returns None if there are no more items in the collection. |
| 972 | </pre> |
| 973 | </div> |
| 974 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 975 | <div class="method"> |
| 976 | <code class="details" id="retry">retry(projectId, id, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 977 | <pre>Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 978 | |
| 979 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 980 | projectId: string, Required. ID of the project. (required) |
| 981 | id: string, Required. Build ID of the original build. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 982 | body: object, The request body. |
| 983 | The object takes the form of: |
| 984 | |
| 985 | { # Specifies a build to retry. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 986 | "id": "A String", # Required. Build ID of the original build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 987 | "name": "A String", # The name of the `Build` to retry. Format: `projects/{project}/locations/{location}/builds/{build}` |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 988 | "projectId": "A String", # Required. ID of the project. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 989 | } |
| 990 | |
| 991 | x__xgafv: string, V1 error format. |
| 992 | Allowed values |
| 993 | 1 - v1 error format |
| 994 | 2 - v2 error format |
| 995 | |
| 996 | Returns: |
| 997 | An object of the form: |
| 998 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 999 | { # This resource represents a long-running operation that is the result of a network API call. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1000 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 1001 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 1002 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1003 | }, |
| 1004 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 1005 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 1006 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1007 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1008 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1009 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1010 | { |
| 1011 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1012 | }, |
| 1013 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1014 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 1015 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1016 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1017 | }</pre> |
| 1018 | </div> |
| 1019 | |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 1020 | </body></html> |