Blame - docs/dyn/cloudbuild_v1.projects.builds.html - platform/external/python/google-api-python-client

2016-05-19 10:54:38 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

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

2016-05-19 10:54:38 -0700

[diff] [blame]

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#create">create(projectId, body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

82

<p class="firstline">Starts a build with the specified configuration.</p>

83

84

<code><a href="#get">get(projectId, id, x__xgafv=None)</a></code></p>

85

<p class="firstline">Returns information about a previously requested build.</p>

86

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

87

<code><a href="#list">list(projectId, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

88

<p class="firstline">Lists previously requested builds.</p>

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

93

<code><a href="#retry">retry(projectId, id, body=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Creates a new build based on the specified build.</p>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

95

<h3>Method Details</h3>

96

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<code class="details" id="cancel">cancel(projectId, id, body=None, x__xgafv=None)</code>

98

<pre>Cancels a build in progress.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

99

100

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

101

projectId: string, Required. ID of the project. (required)

102

id: string, Required. ID of the build. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

104

The object takes the form of:

105

106

{ # Request to cancel an ongoing build.

107

}

108

109

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

116

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

117

{ # A build resource in the Cloud Build API.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

118

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

119

# At a high level, a `Build` describes where to find source code, how to build

120

# it (for example, the builder image to run on the source), and where to store

121

# the built artifacts.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

122

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

123

# Fields can include the following variables, which will be expanded when the

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

124

# build is created:

125

#

126

# - $PROJECT_ID: the project ID of the build.

127

# - $BUILD_ID: the autogenerated ID of the build.

128

# - $REPO_NAME: the source repository name specified by RepoSource.

129

# - $BRANCH_NAME: the branch name specified by RepoSource.

130

# - $TAG_NAME: the tag name specified by RepoSource.

131

# - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or

132

# resolved from the specified branch or tag.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

133

# - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

134

"startTime": "A String", # Output only. Time at which execution of the build was started.

135

"substitutions": { # Substitutions data for `Build` resource.

136

"a_key": "A String",

137

},

138

"timing": { # Output only. Stores timing information for phases of the build. Valid keys

139

# are:

140

#

141

# * BUILD: time to execute all build steps

142

# * PUSH: time to push all specified images.

143

# * FETCHSOURCE: time to fetch source.

144

#

145

# If the build does not specify source or images,

146

# these keys will not be included.

147

"a_key": { # Start and end times for a build execution phase.

148

"endTime": "A String", # End of time span.

149

"startTime": "A String", # Start of time span.

150

},

151

},

152

"createTime": "A String", # Output only. Time at which the request to create the build was received.

153

"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.

154

# some source was used for this build.

155

"fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that

156

# the original source integrity was maintained in the build. Note that

157

# `FileHashes` will only be populated if `BuildOptions` has requested a

158

# `SourceProvenanceHash`.

159

#

160

# The keys to this map are file paths used as build source and the values

161

# contain the hash values for those files.

162

#

163

# If the build source came in a single package such as a gzipped tarfile

164

# (`.tar.gz`), the `FileHash` will be for the single path to that file.

165

"a_key": { # Container message for hashes of byte content of files, used in

166

# SourceProvenance messages to verify integrity of source input to the build.

167

"fileHash": [ # Collection of file hashes.

168

{ # Container message for hash values.

169

"type": "A String", # The type of hash that was performed.

170

"value": "A String", # The hash value.

},

],

},

},

"resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any

176

# revisions resolved.

177

"branchName": "A String", # Regex matching branches to build.

178

#

179

# The syntax of the regular expressions accepted is the syntax accepted by

180

# RE2 and described at https://github.com/google/re2/wiki/Syntax

181

"dir": "A String", # Directory, relative to the source root, in which to run the build.

182

#

183

# This must be a relative path. If a step's `dir` is specified and is an

184

# absolute path, this value is ignored for that step's execution.

185

"tagName": "A String", # Regex matching tags to build.

186

#

187

# The syntax of the regular expressions accepted is the syntax accepted by

188

# RE2 and described at https://github.com/google/re2/wiki/Syntax

189

"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the

190

# project ID requesting the build is assumed.

191

"repoName": "A String", # Required. Name of the Cloud Source Repository.

192

"commitSha": "A String", # Explicit commit SHA to build.

193

"substitutions": { # Substitutions to use in a triggered build.

194

# Should only be used with RunBuildTrigger

195

"a_key": "A String",

196

},

197

"invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision

198

# regex.

199

},

200

"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

201

# generations resolved.

202

"object": "A String", # Google Cloud Storage object containing the source.

203

#

204

# This object must be a gzipped archive file (`.tar.gz`) containing source to

205

# build.

206

"generation": "A String", # Google Cloud Storage generation for the object. If the generation is

207

# omitted, the latest generation will be used.

208

"bucket": "A String", # Google Cloud Storage bucket containing the source (see

209

# [Bucket Name

210

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

211

},

212

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

213

"images": [ # A list of images to be pushed upon the successful completion of all build

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

214

# steps.

215

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

216

# The images are pushed using the builder service account's credentials.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

217

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

218

# The digests of the pushed images will be stored in the `Build` resource's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

219

# results field.

220

#

221

# If any of the images fail to be pushed, the build status is marked

222

# `FAILURE`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

223

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

224

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

225

"projectId": "A String", # Output only. ID of the project.

226

"logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.

227

"queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

228

# than this value, the build will expire and the build status will be

229

# `EXPIRED`.

230

#

231

# The TTL starts ticking from create_time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

"finishTime": "A String", # Output only. Time at which execution of the build was finished.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

233

#

234

# The difference between finish_time and start_time is the duration of the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

235

# build's execution.

236

"source": { # Location of the source in a supported storage service. # The location of the source files to build.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

237

"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source

238

# Repository.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

239

"branchName": "A String", # Regex matching branches to build.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

240

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

241

# The syntax of the regular expressions accepted is the syntax accepted by

242

# RE2 and described at https://github.com/google/re2/wiki/Syntax

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

243

"dir": "A String", # Directory, relative to the source root, in which to run the build.

244

#

245

# This must be a relative path. If a step's `dir` is specified and is an

246

# absolute path, this value is ignored for that step's execution.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

247

"tagName": "A String", # Regex matching tags to build.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

248

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

249

# The syntax of the regular expressions accepted is the syntax accepted by

250

# RE2 and described at https://github.com/google/re2/wiki/Syntax

251

"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the

252

# project ID requesting the build is assumed.

253

"repoName": "A String", # Required. Name of the Cloud Source Repository.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

254

"commitSha": "A String", # Explicit commit SHA to build.

255

"substitutions": { # Substitutions to use in a triggered build.

256

# Should only be used with RunBuildTrigger

257

"a_key": "A String",

258

},

259

"invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision

260

# regex.

261

},

262

"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.

263

"object": "A String", # Google Cloud Storage object containing the source.

264

#

265

# This object must be a gzipped archive file (`.tar.gz`) containing source to

266

# build.

267

"generation": "A String", # Google Cloud Storage generation for the object. If the generation is

268

# omitted, the latest generation will be used.

269

"bucket": "A String", # Google Cloud Storage bucket containing the source (see

270

# [Bucket Name

271

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

272

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

273

},

274

"options": { # Optional arguments to enable specific features of builds. # Special options for this build.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

275

"logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud

276

# Storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

277

"env": [ # A list of global environment variable definitions that will exist for all

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

278

# build steps in this build. If a variable is defined in both globally and in

279

# a build step, the variable will use the build step value.

280

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

281

# The elements are of the form "KEY=VALUE" for the environment variable "KEY"

282

# being given the value "VALUE".

283

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

284

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

285

"workerPool": "A String", # Option to specify a `WorkerPool` for the build.

286

# Format: projects/{project}/workerPools/{workerPool}

287

#

288

# This field is experimental.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

289

"logging": "A String", # Option to specify the logging mode, which determines where the logs are

290

# stored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

291

"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution

292

# checks.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

293

"requestedVerifyOption": "A String", # Requested verifiability options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

294

"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*

295

# "disk free"; some of the space will be used by the operating system and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

296

# build utilities. Also note that this is the minimum disk size that will be

297

# allocated for the build -- the build may run with a larger disk than

298

# requested. At present, the maximum disk size is 1000GB; builds that request

299

# more than the maximum are rejected with an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

300

"sourceProvenanceHash": [ # Requested hash for SourceProvenance.

301

"A String",

302

],

303

"secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud

304

# Key Management Service crypto key. These values must be specified in the

305

# build's `Secret`. These variables will be available to all build steps

306

# in this build.

307

"A String",

308

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

309

"machineType": "A String", # Compute Engine machine type on which to run the build.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

310

"volumes": [ # Global list of volumes to mount for ALL build steps

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

311

#

312

# Each volume is created as an empty volume prior to starting the build

313

# process. Upon completion of the build, volumes and their contents are

314

# discarded. Global volume names and paths cannot conflict with the volumes

315

# defined a build step.

316

#

317

# Using a global volume in a build with only one step is not valid as

318

# it is indicative of a build request with an incorrect configuration.

319

{ # Volume describes a Docker container volume which is mounted into build steps

320

# in order to persist files across build step execution.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

321

"path": "A String", # Path at which to mount the volume.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

322

#

323

# Paths must be absolute and cannot conflict with other volume paths on the

324

# same build step or with certain reserved volume paths.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

325

"name": "A String", # Name of the volume to mount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

326

#

327

# Volume names must be unique per build step and must be valid names for

328

# Docker volumes. Each named volume must be used by at least two build steps.

329

},

330

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

331

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

332

"timeout": "A String", # Amount of time that this build should be allowed to run, to second

333

# granularity. If this amount of time elapses, work on the build will cease

334

# and the build status will be `TIMEOUT`.

335

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

336

# `timeout` starts ticking from `startTime`.

337

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

338

# Default time is ten minutes.

339

"status": "A String", # Output only. Status of the build.

340

"statusDetail": "A String", # Output only. Customer-readable message about the current status.

341

"artifacts": { # Artifacts produced by a build that should be uploaded upon # Artifacts produced by the build that should be uploaded upon

342

# successful completion of all build steps.

343

# successful completion of all build steps.

344

"objects": { # Files in the workspace to upload to Cloud Storage upon successful # A list of objects to be uploaded to Cloud Storage upon successful

345

# completion of all build steps.

346

#

347

# Files in the workspace matching specified paths globs will be uploaded to

348

# the specified Cloud Storage location using the builder service account's

349

# credentials.

350

#

351

# The location and generation of the uploaded objects will be stored in the

352

# Build resource's results field.

353

#

354

# If any objects fail to be pushed, the build is marked FAILURE.

355

# completion of all build steps.

356

"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.

357

"endTime": "A String", # End of time span.

358

"startTime": "A String", # Start of time span.

359

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

360

"location": "A String", # Cloud Storage bucket and optional object path, in the form

361

# "gs://bucket/path/to/somewhere/". (see [Bucket Name

362

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

363

#

364

# Files in the workspace matching any path pattern will be uploaded to

365

# Cloud Storage with this location as a prefix.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

366

"paths": [ # Path globs used to match files in the build's workspace.

367

"A String",

368

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

369

},

370

"images": [ # A list of images to be pushed upon the successful completion of all build

371

# steps.

372

#

373

# The images will be pushed using the builder service account's credentials.

374

#

375

# The digests of the pushed images will be stored in the Build resource's

376

# results field.

377

#

378

# If any of the images fail to be pushed, the build is marked FAILURE.

"A String",

],

},

"secrets": [ # Secrets to decrypt using Cloud Key Management Service.

383

{ # Pairs a set of secret environment variables containing encrypted

384

# values with the Cloud KMS key to use to decrypt the value.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

385

"kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

386

"secretEnv": { # Map of environment variable name to its encrypted value.

387

#

388

# Secret environment variables must be unique across all of a build's

389

# secrets, and must be used by at least one build step. Values can be at most

390

# 64 KB in size. There can be at most 100 secret values across all of a

391

# build's secrets.

392

"a_key": "A String",

393

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

394

},

395

],

396

"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

397

"numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.

398

"artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

399

"buildStepImages": [ # List of build step digests, in the order corresponding to build step

# indices.

"A String",

],

"artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts.

404

"endTime": "A String", # End of time span.

405

"startTime": "A String", # Start of time span.

406

},

407

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order

408

# corresponding to build step indices.

409

#

410

# [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)

411

# can produce this output by writing to `$BUILDER_OUTPUT/output`.

412

# Only the first 4KB of data is stored.

413

"A String",

414

],

415

"images": [ # Container images that were built as a part of the build.

416

{ # An image built by the pipeline.

417

"name": "A String", # Name used to push the container image to Google Container Registry, as

418

# presented to `docker push`.

419

"digest": "A String", # Docker Registry 2.0 digest.

420

"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.

421

"endTime": "A String", # End of time span.

422

"startTime": "A String", # Start of time span.

423

},

424

},

425

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

426

},

427

"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see

428

# [Bucket Name

429

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

430

# Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.

431

"steps": [ # Required. The operations to be performed on the workspace.

432

{ # A step in the build pipeline.

433

"entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint.

434

# If unset, the image's default entrypoint is used.

435

"volumes": [ # List of volumes to mount into the build step.

436

#

437

# Each volume is created as an empty volume prior to execution of the

438

# build step. Upon completion of the build, volumes and their contents are

439

# discarded.

440

#

441

# Using a named volume in only one step is not valid as it is indicative

442

# of a build request with an incorrect configuration.

443

{ # Volume describes a Docker container volume which is mounted into build steps

444

# in order to persist files across build step execution.

445

"path": "A String", # Path at which to mount the volume.

446

#

447

# Paths must be absolute and cannot conflict with other volume paths on the

448

# same build step or with certain reserved volume paths.

449

"name": "A String", # Name of the volume to mount.

450

#

451

# Volume names must be unique per build step and must be valid names for

452

# Docker volumes. Each named volume must be used by at least two build steps.

453

},

454

],

455

"args": [ # A list of arguments that will be presented to the step when it is started.

456

#

457

# If the image used to run the step's container has an entrypoint, the `args`

458

# are used as arguments to that entrypoint. If the image does not define

459

# an entrypoint, the first element in args is used as the entrypoint,

460

# and the remainder will be used as arguments.

461

"A String",

462

],

463

"status": "A String", # Output only. Status of the build step. At this time, build step status is

464

# only updated on build completion; step status is not updated in real-time

465

# as the build progresses.

466

"timeout": "A String", # Time limit for executing this build step. If not defined, the step has no

467

# time limit and will be allowed to continue to run until either it completes

468

# or the build itself times out.

469

"pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's

470

# builder image only.

471

"endTime": "A String", # End of time span.

472

"startTime": "A String", # Start of time span.

473

},

474

"name": "A String", # Required. The name of the container image that will run this particular

475

# build step.

476

#

477

# If the image is available in the host's Docker daemon's cache, it

478

# will be run directly. If not, the host will attempt to pull the image

479

# first, using the builder service account's credentials if necessary.

480

#

481

# The Docker daemon's cache will already have the latest versions of all of

482

# the officially supported build steps

483

# ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).

484

# The Docker daemon will also have cached many of the layers for some popular

485

# images, like "ubuntu", "debian", but they will be refreshed at the time you

486

# attempt to use them.

487

#

488

# If you built an image in a previous build step, it will be stored in the

489

# host's Docker daemon's cache and is available to use as the name for a

490

# later build step.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

491

"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key

492

# Management Service crypto key. These values must be specified in the

493

# build's `Secret`.

494

"A String",

495

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

496

"id": "A String", # Unique identifier for this build step, used in `wait_for` to

497

# reference this build step as a dependency.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

498

"dir": "A String", # Working directory to use when running this step's container.

499

#

500

# If this value is a relative path, it is relative to the build's working

501

# directory. If this value is absolute, it may be outside the build's working

502

# directory, in which case the contents of the path may not be persisted

503

# across build step executions, unless a `volume` for that path is specified.

504

#

505

# If the build specifies a `RepoSource` with `dir` and a step with a `dir`,

506

# which specifies an absolute path, the `RepoSource` `dir` is ignored for

507

# the step's execution.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

508

"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.

509

"endTime": "A String", # End of time span.

510

"startTime": "A String", # Start of time span.

511

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

512

"waitFor": [ # The ID(s) of the step(s) that this build step depends on.

513

# This build step will not start until all the build steps in `wait_for`

514

# have completed successfully. If `wait_for` is empty, this build step will

515

# start when all previous build steps in the `Build.Steps` list have

516

# completed successfully.

517

"A String",

518

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

519

"env": [ # A list of environment variable definitions to be used when running a step.

520

#

521

# The elements are of the form "KEY=VALUE" for the environment variable "KEY"

522

# being given the value "VALUE".

523

"A String",

524

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

525

},

526

],

527

"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it

528

# was triggered automatically.

529

"id": "A String", # Output only. Unique identifier of the build.

530

"tags": [ # Tags for annotation of a `Build`. These are not docker tags.

531

"A String",

532

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

537

<code class="details" id="create">create(projectId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

538

<pre>Starts a build with the specified configuration.

539

540

This method returns a long-running `Operation`, which includes the build

541

ID. Pass the build ID to `GetBuild` to determine the build status (such as

542

`SUCCESS` or `FAILURE`).

543

544

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

545

projectId: string, Required. ID of the project. (required)

546

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

547

The object takes the form of:

548

549

{ # A build resource in the Cloud Build API.

550

#

551

# At a high level, a `Build` describes where to find source code, how to build

552

# it (for example, the builder image to run on the source), and where to store

553

# the built artifacts.

554

#

555

# Fields can include the following variables, which will be expanded when the

556

# build is created:

557

#

558

# - $PROJECT_ID: the project ID of the build.

559

# - $BUILD_ID: the autogenerated ID of the build.

560

# - $REPO_NAME: the source repository name specified by RepoSource.

561

# - $BRANCH_NAME: the branch name specified by RepoSource.

562

# - $TAG_NAME: the tag name specified by RepoSource.

563

# - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or

564

# resolved from the specified branch or tag.

565

# - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

566

"startTime": "A String", # Output only. Time at which execution of the build was started.

567

"substitutions": { # Substitutions data for `Build` resource.

568

"a_key": "A String",

569

},

570

"timing": { # Output only. Stores timing information for phases of the build. Valid keys

571

# are:

572

#

573

# * BUILD: time to execute all build steps

574

# * PUSH: time to push all specified images.

575

# * FETCHSOURCE: time to fetch source.

576

#

577

# If the build does not specify source or images,

578

# these keys will not be included.

579

"a_key": { # Start and end times for a build execution phase.

580

"endTime": "A String", # End of time span.

581

"startTime": "A String", # Start of time span.

582

},

583

},

584

"createTime": "A String", # Output only. Time at which the request to create the build was received.

585

"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.

586

# some source was used for this build.

587

"fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that

588

# the original source integrity was maintained in the build. Note that

589

# `FileHashes` will only be populated if `BuildOptions` has requested a

590

# `SourceProvenanceHash`.

591

#

592

# The keys to this map are file paths used as build source and the values

593

# contain the hash values for those files.

594

#

595

# If the build source came in a single package such as a gzipped tarfile

596

# (`.tar.gz`), the `FileHash` will be for the single path to that file.

597

"a_key": { # Container message for hashes of byte content of files, used in

598

# SourceProvenance messages to verify integrity of source input to the build.

599

"fileHash": [ # Collection of file hashes.

600

{ # Container message for hash values.

601

"type": "A String", # The type of hash that was performed.

602

"value": "A String", # The hash value.

},

],

},

},

"resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any

608

# revisions resolved.

609

"branchName": "A String", # Regex matching branches to build.

610

#

611

# The syntax of the regular expressions accepted is the syntax accepted by

612

# RE2 and described at https://github.com/google/re2/wiki/Syntax

613

"dir": "A String", # Directory, relative to the source root, in which to run the build.

614

#

615

# This must be a relative path. If a step's `dir` is specified and is an

616

# absolute path, this value is ignored for that step's execution.

617

"tagName": "A String", # Regex matching tags to build.

618

#

619

# The syntax of the regular expressions accepted is the syntax accepted by

620

# RE2 and described at https://github.com/google/re2/wiki/Syntax

621

"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the

622

# project ID requesting the build is assumed.

623

"repoName": "A String", # Required. Name of the Cloud Source Repository.

624

"commitSha": "A String", # Explicit commit SHA to build.

625

"substitutions": { # Substitutions to use in a triggered build.

626

# Should only be used with RunBuildTrigger

627

"a_key": "A String",

628

},

629

"invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision

630

# regex.

631

},

632

"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

633

# generations resolved.

634

"object": "A String", # Google Cloud Storage object containing the source.

635

#

636

# This object must be a gzipped archive file (`.tar.gz`) containing source to

637

# build.

638

"generation": "A String", # Google Cloud Storage generation for the object. If the generation is

639

# omitted, the latest generation will be used.

640

"bucket": "A String", # Google Cloud Storage bucket containing the source (see

641

# [Bucket Name

642

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

643

},

644

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

645

"images": [ # A list of images to be pushed upon the successful completion of all build

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

646

# steps.

647

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

648

# The images are pushed using the builder service account's credentials.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

649

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

650

# The digests of the pushed images will be stored in the `Build` resource's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

651

# results field.

652

#

653

# If any of the images fail to be pushed, the build status is marked

654

# `FAILURE`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

655

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

656

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

657

"projectId": "A String", # Output only. ID of the project.

658

"logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.

659

"queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

660

# than this value, the build will expire and the build status will be

661

# `EXPIRED`.

662

#

663

# The TTL starts ticking from create_time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

664

"finishTime": "A String", # Output only. Time at which execution of the build was finished.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

665

#

666

# The difference between finish_time and start_time is the duration of the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

667

# build's execution.

668

"source": { # Location of the source in a supported storage service. # The location of the source files to build.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

669

"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source

670

# Repository.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

671

"branchName": "A String", # Regex matching branches to build.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

672

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

673

# The syntax of the regular expressions accepted is the syntax accepted by

674

# RE2 and described at https://github.com/google/re2/wiki/Syntax

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

675

"dir": "A String", # Directory, relative to the source root, in which to run the build.

676

#

677

# This must be a relative path. If a step's `dir` is specified and is an

678

# absolute path, this value is ignored for that step's execution.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

679

"tagName": "A String", # Regex matching tags to build.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

680

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

681

# The syntax of the regular expressions accepted is the syntax accepted by

682

# RE2 and described at https://github.com/google/re2/wiki/Syntax

683

"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the

684

# project ID requesting the build is assumed.

685

"repoName": "A String", # Required. Name of the Cloud Source Repository.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

686

"commitSha": "A String", # Explicit commit SHA to build.

687

"substitutions": { # Substitutions to use in a triggered build.

688

# Should only be used with RunBuildTrigger

689

"a_key": "A String",

690

},

691

"invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision

692

# regex.

693

},

694

"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.

695

"object": "A String", # Google Cloud Storage object containing the source.

696

#

697

# This object must be a gzipped archive file (`.tar.gz`) containing source to

698

# build.

699

"generation": "A String", # Google Cloud Storage generation for the object. If the generation is

700

# omitted, the latest generation will be used.

701

"bucket": "A String", # Google Cloud Storage bucket containing the source (see

702

# [Bucket Name

703

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

704

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

705

},

706

"options": { # Optional arguments to enable specific features of builds. # Special options for this build.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

707

"logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud

708

# Storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

709

"env": [ # A list of global environment variable definitions that will exist for all

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

710

# build steps in this build. If a variable is defined in both globally and in

711

# a build step, the variable will use the build step value.

712

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

713

# The elements are of the form "KEY=VALUE" for the environment variable "KEY"

714

# being given the value "VALUE".

715

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

716

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

717

"workerPool": "A String", # Option to specify a `WorkerPool` for the build.

718

# Format: projects/{project}/workerPools/{workerPool}

719

#

720

# This field is experimental.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

721

"logging": "A String", # Option to specify the logging mode, which determines where the logs are

722

# stored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

723

"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution

724

# checks.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

725

"requestedVerifyOption": "A String", # Requested verifiability options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

726

"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*

727

# "disk free"; some of the space will be used by the operating system and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

728

# build utilities. Also note that this is the minimum disk size that will be

729

# allocated for the build -- the build may run with a larger disk than

730

# requested. At present, the maximum disk size is 1000GB; builds that request

731

# more than the maximum are rejected with an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

732

"sourceProvenanceHash": [ # Requested hash for SourceProvenance.

733

"A String",

734

],

735

"secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud

736

# Key Management Service crypto key. These values must be specified in the

737

# build's `Secret`. These variables will be available to all build steps

738

# in this build.

739

"A String",

740

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

741

"machineType": "A String", # Compute Engine machine type on which to run the build.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

742

"volumes": [ # Global list of volumes to mount for ALL build steps

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

743

#

744

# Each volume is created as an empty volume prior to starting the build

745

# process. Upon completion of the build, volumes and their contents are

746

# discarded. Global volume names and paths cannot conflict with the volumes

747

# defined a build step.

748

#

749

# Using a global volume in a build with only one step is not valid as

750

# it is indicative of a build request with an incorrect configuration.

751

{ # Volume describes a Docker container volume which is mounted into build steps

752

# in order to persist files across build step execution.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

753

"path": "A String", # Path at which to mount the volume.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

754

#

755

# Paths must be absolute and cannot conflict with other volume paths on the

756

# same build step or with certain reserved volume paths.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

757

"name": "A String", # Name of the volume to mount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

758

#

759

# Volume names must be unique per build step and must be valid names for

760

# Docker volumes. Each named volume must be used by at least two build steps.

761

},

762

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

763

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

764

"timeout": "A String", # Amount of time that this build should be allowed to run, to second

765

# granularity. If this amount of time elapses, work on the build will cease

766

# and the build status will be `TIMEOUT`.

767

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

768

# `timeout` starts ticking from `startTime`.

769

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

770

# Default time is ten minutes.

771

"status": "A String", # Output only. Status of the build.

772

"statusDetail": "A String", # Output only. Customer-readable message about the current status.

773

"artifacts": { # Artifacts produced by a build that should be uploaded upon # Artifacts produced by the build that should be uploaded upon

774

# successful completion of all build steps.

775

# successful completion of all build steps.

776

"objects": { # Files in the workspace to upload to Cloud Storage upon successful # A list of objects to be uploaded to Cloud Storage upon successful

777

# completion of all build steps.

778

#

779

# Files in the workspace matching specified paths globs will be uploaded to

780

# the specified Cloud Storage location using the builder service account's

781

# credentials.

782

#

783

# The location and generation of the uploaded objects will be stored in the

784

# Build resource's results field.

785

#

786

# If any objects fail to be pushed, the build is marked FAILURE.

787

# completion of all build steps.

788

"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.

789

"endTime": "A String", # End of time span.

790

"startTime": "A String", # Start of time span.

791

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

792

"location": "A String", # Cloud Storage bucket and optional object path, in the form

793

# "gs://bucket/path/to/somewhere/". (see [Bucket Name

794

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

795

#

796

# Files in the workspace matching any path pattern will be uploaded to

797

# Cloud Storage with this location as a prefix.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

798

"paths": [ # Path globs used to match files in the build's workspace.

799

"A String",

800

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

801

},

802

"images": [ # A list of images to be pushed upon the successful completion of all build

803

# steps.

804

#

805

# The images will be pushed using the builder service account's credentials.

806

#

807

# The digests of the pushed images will be stored in the Build resource's

808

# results field.

809

#

810

# If any of the images fail to be pushed, the build is marked FAILURE.

"A String",

],

},

"secrets": [ # Secrets to decrypt using Cloud Key Management Service.

815

{ # Pairs a set of secret environment variables containing encrypted

816

# values with the Cloud KMS key to use to decrypt the value.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

817

"kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

818

"secretEnv": { # Map of environment variable name to its encrypted value.

819

#

820

# Secret environment variables must be unique across all of a build's

821

# secrets, and must be used by at least one build step. Values can be at most

822

# 64 KB in size. There can be at most 100 secret values across all of a

823

# build's secrets.

824

"a_key": "A String",

825

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

826

},

827

],

828

"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

829

"numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.

830

"artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

831

"buildStepImages": [ # List of build step digests, in the order corresponding to build step

# indices.

"A String",

],

"artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts.

836

"endTime": "A String", # End of time span.

837

"startTime": "A String", # Start of time span.

838

},

839

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order

840

# corresponding to build step indices.

841

#

842

# [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)

843

# can produce this output by writing to `$BUILDER_OUTPUT/output`.

844

# Only the first 4KB of data is stored.

845

"A String",

846

],

847

"images": [ # Container images that were built as a part of the build.

848

{ # An image built by the pipeline.

849

"name": "A String", # Name used to push the container image to Google Container Registry, as

850

# presented to `docker push`.

851

"digest": "A String", # Docker Registry 2.0 digest.

852

"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.

853

"endTime": "A String", # End of time span.

854

"startTime": "A String", # Start of time span.

855

},

856

},

857

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

858

},

859

"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see

860

# [Bucket Name

861

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

862

# Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.

863

"steps": [ # Required. The operations to be performed on the workspace.

864

{ # A step in the build pipeline.

865

"entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint.

866

# If unset, the image's default entrypoint is used.

867

"volumes": [ # List of volumes to mount into the build step.

868

#

869

# Each volume is created as an empty volume prior to execution of the

870

# build step. Upon completion of the build, volumes and their contents are

871

# discarded.

872

#

873

# Using a named volume in only one step is not valid as it is indicative

874

# of a build request with an incorrect configuration.

875

{ # Volume describes a Docker container volume which is mounted into build steps

876

# in order to persist files across build step execution.

877

"path": "A String", # Path at which to mount the volume.

878

#

879

# Paths must be absolute and cannot conflict with other volume paths on the

880

# same build step or with certain reserved volume paths.

881

"name": "A String", # Name of the volume to mount.

882

#

883

# Volume names must be unique per build step and must be valid names for

884

# Docker volumes. Each named volume must be used by at least two build steps.

885

},

886

],

887

"args": [ # A list of arguments that will be presented to the step when it is started.

888

#

889

# If the image used to run the step's container has an entrypoint, the `args`

890

# are used as arguments to that entrypoint. If the image does not define

891

# an entrypoint, the first element in args is used as the entrypoint,

892

# and the remainder will be used as arguments.

893

"A String",

894

],

895

"status": "A String", # Output only. Status of the build step. At this time, build step status is

896

# only updated on build completion; step status is not updated in real-time

897

# as the build progresses.

898

"timeout": "A String", # Time limit for executing this build step. If not defined, the step has no

899

# time limit and will be allowed to continue to run until either it completes

900

# or the build itself times out.

901

"pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's

902

# builder image only.

903

"endTime": "A String", # End of time span.

904

"startTime": "A String", # Start of time span.

905

},

906

"name": "A String", # Required. The name of the container image that will run this particular

907

# build step.

908

#

909

# If the image is available in the host's Docker daemon's cache, it

910

# will be run directly. If not, the host will attempt to pull the image

911

# first, using the builder service account's credentials if necessary.

912

#

913

# The Docker daemon's cache will already have the latest versions of all of

914

# the officially supported build steps

915

# ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).

916

# The Docker daemon will also have cached many of the layers for some popular

917

# images, like "ubuntu", "debian", but they will be refreshed at the time you

918

# attempt to use them.

919

#

920

# If you built an image in a previous build step, it will be stored in the

921

# host's Docker daemon's cache and is available to use as the name for a

922

# later build step.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

923

"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key

924

# Management Service crypto key. These values must be specified in the

925

# build's `Secret`.

926

"A String",

927

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

928

"id": "A String", # Unique identifier for this build step, used in `wait_for` to

929

# reference this build step as a dependency.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

930

"dir": "A String", # Working directory to use when running this step's container.

931

#

932

# If this value is a relative path, it is relative to the build's working

933

# directory. If this value is absolute, it may be outside the build's working

934

# directory, in which case the contents of the path may not be persisted

935

# across build step executions, unless a `volume` for that path is specified.

936

#

937

# If the build specifies a `RepoSource` with `dir` and a step with a `dir`,

938

# which specifies an absolute path, the `RepoSource` `dir` is ignored for

939

# the step's execution.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

940

"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.

941

"endTime": "A String", # End of time span.

942

"startTime": "A String", # Start of time span.

943

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

944

"waitFor": [ # The ID(s) of the step(s) that this build step depends on.

945

# This build step will not start until all the build steps in `wait_for`

946

# have completed successfully. If `wait_for` is empty, this build step will

947

# start when all previous build steps in the `Build.Steps` list have

948

# completed successfully.

949

"A String",

950

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

951

"env": [ # A list of environment variable definitions to be used when running a step.

952

#

953

# The elements are of the form "KEY=VALUE" for the environment variable "KEY"

954

# being given the value "VALUE".

955

"A String",

956

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

957

},

958

],

959

"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it

960

# was triggered automatically.

961

"id": "A String", # Output only. Unique identifier of the build.

962

"tags": [ # Tags for annotation of a `Build`. These are not docker tags.

963

"A String",

964

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

965

}

966

967

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

974

975

{ # This resource represents a long-running operation that is the result of a

976

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

977

"name": "A String", # The server-assigned name, which is only unique within the same service that

978

# originally returns it. If you use the default HTTP mapping, the

979

# `name` should be a resource name ending with `operations/{unique_id}`.

980

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

981

# different programming environments, including REST APIs and RPC APIs. It is

982

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

983

# three pieces of data: error code, error message, and error details.

984

#

985

# You can find out more about this error model and how to work with it in the

986

# [API Design Guide](https://cloud.google.com/apis/design/errors).

987

"message": "A String", # A developer-facing error message, which should be in English. Any

988

# user-facing error message should be localized and sent in the

989

# google.rpc.Status.details field, or localized by the client.

990

"details": [ # A list of messages that carry the error details. There is a common set of

991

# message types for APIs to use.

992

{

993

"a_key": "", # Properties of the object. Contains field @type with type URL.

994

},

995

],

996

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

997

},

998

"metadata": { # Service-specific metadata associated with the operation. It typically

999

# contains progress information and common metadata such as create time.

1000

# Some services might not provide such metadata. Any method that returns a

1001

# long-running operation should document the metadata type, if any.

1002

"a_key": "", # Properties of the object. Contains field @type with type URL.

1003

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1004

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1005

# If `true`, the operation is completed, and either `error` or `response` is

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

1006

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1007

"response": { # The normal response of the operation in case of success. If the original

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

1008

# method returns no data on success, such as `Delete`, the response is

1009

# `google.protobuf.Empty`. If the original method is standard

1010

# `Get`/`Create`/`Update`, the response should be the resource. For other

1011

# methods, the response should have the type `XxxResponse`, where `Xxx`

1012

# is the original method name. For example, if the original method name

1013

# is `TakeSnapshot()`, the inferred response type is

1014

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1015

"a_key": "", # Properties of the object. Contains field @type with type URL.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

1016

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(projectId, id, x__xgafv=None)</code>

1022

<pre>Returns information about a previously requested build.

1023

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1024

The `Build` that is returned includes its status (such as `SUCCESS`,

1025

`FAILURE`, or `WORKING`), and timing information.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1026

1027

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1028

projectId: string, Required. ID of the project. (required)

1029

id: string, Required. ID of the build. (required)

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1030

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1037

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1038

{ # A build resource in the Cloud Build API.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1039

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1040

# At a high level, a `Build` describes where to find source code, how to build

1041

# it (for example, the builder image to run on the source), and where to store

1042

# the built artifacts.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1043

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1044

# Fields can include the following variables, which will be expanded when the

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1045

# build is created:

1046

#

1047

# - $PROJECT_ID: the project ID of the build.

1048

# - $BUILD_ID: the autogenerated ID of the build.

1049

# - $REPO_NAME: the source repository name specified by RepoSource.

1050

# - $BRANCH_NAME: the branch name specified by RepoSource.

1051

# - $TAG_NAME: the tag name specified by RepoSource.

1052

# - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or

1053

# resolved from the specified branch or tag.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1054

# - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1055

"startTime": "A String", # Output only. Time at which execution of the build was started.

1056

"substitutions": { # Substitutions data for `Build` resource.

1057

"a_key": "A String",

1058

},

1059

"timing": { # Output only. Stores timing information for phases of the build. Valid keys

1060

# are:

1061

#

1062

# * BUILD: time to execute all build steps

1063

# * PUSH: time to push all specified images.

1064

# * FETCHSOURCE: time to fetch source.

1065

#

1066

# If the build does not specify source or images,

1067

# these keys will not be included.

1068

"a_key": { # Start and end times for a build execution phase.

1069

"endTime": "A String", # End of time span.

1070

"startTime": "A String", # Start of time span.

1071

},

1072

},

1073

"createTime": "A String", # Output only. Time at which the request to create the build was received.

1074

"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.

1075

# some source was used for this build.

1076

"fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that

1077

# the original source integrity was maintained in the build. Note that

1078

# `FileHashes` will only be populated if `BuildOptions` has requested a

1079

# `SourceProvenanceHash`.

1080

#

1081

# The keys to this map are file paths used as build source and the values

1082

# contain the hash values for those files.

1083

#

1084

# If the build source came in a single package such as a gzipped tarfile

1085

# (`.tar.gz`), the `FileHash` will be for the single path to that file.

1086

"a_key": { # Container message for hashes of byte content of files, used in

1087

# SourceProvenance messages to verify integrity of source input to the build.

1088

"fileHash": [ # Collection of file hashes.

1089

{ # Container message for hash values.

1090

"type": "A String", # The type of hash that was performed.

1091

"value": "A String", # The hash value.

},

],

},

},

"resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any

1097

# revisions resolved.

1098

"branchName": "A String", # Regex matching branches to build.

1099

#

1100

# The syntax of the regular expressions accepted is the syntax accepted by

1101

# RE2 and described at https://github.com/google/re2/wiki/Syntax

1102

"dir": "A String", # Directory, relative to the source root, in which to run the build.

1103

#

1104

# This must be a relative path. If a step's `dir` is specified and is an

1105

# absolute path, this value is ignored for that step's execution.

1106

"tagName": "A String", # Regex matching tags to build.

1107

#

1108

# The syntax of the regular expressions accepted is the syntax accepted by

1109

# RE2 and described at https://github.com/google/re2/wiki/Syntax

1110

"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the

1111

# project ID requesting the build is assumed.

1112

"repoName": "A String", # Required. Name of the Cloud Source Repository.

1113

"commitSha": "A String", # Explicit commit SHA to build.

1114

"substitutions": { # Substitutions to use in a triggered build.

1115

# Should only be used with RunBuildTrigger

1116

"a_key": "A String",

1117

},

1118

"invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision

1119

# regex.

1120

},

1121

"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

1122

# generations resolved.

1123

"object": "A String", # Google Cloud Storage object containing the source.

1124

#

1125

# This object must be a gzipped archive file (`.tar.gz`) containing source to

1126

# build.

1127

"generation": "A String", # Google Cloud Storage generation for the object. If the generation is

1128

# omitted, the latest generation will be used.

1129

"bucket": "A String", # Google Cloud Storage bucket containing the source (see

1130

# [Bucket Name

1131

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1132

},

1133

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1134

"images": [ # A list of images to be pushed upon the successful completion of all build

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1135

# steps.

1136

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1137

# The images are pushed using the builder service account's credentials.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1138

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1139

# The digests of the pushed images will be stored in the `Build` resource's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1140

# results field.

1141

#

1142

# If any of the images fail to be pushed, the build status is marked

1143

# `FAILURE`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1144

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1145

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1146

"projectId": "A String", # Output only. ID of the project.

1147

"logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.

1148

"queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1149

# than this value, the build will expire and the build status will be

1150

# `EXPIRED`.

1151

#

1152

# The TTL starts ticking from create_time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1153

"finishTime": "A String", # Output only. Time at which execution of the build was finished.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1154

#

1155

# The difference between finish_time and start_time is the duration of the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1156

# build's execution.

1157

"source": { # Location of the source in a supported storage service. # The location of the source files to build.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1158

"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source

1159

# Repository.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1160

"branchName": "A String", # Regex matching branches to build.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1161

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1162

# The syntax of the regular expressions accepted is the syntax accepted by

1163

# RE2 and described at https://github.com/google/re2/wiki/Syntax

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1164

"dir": "A String", # Directory, relative to the source root, in which to run the build.

1165

#

1166

# This must be a relative path. If a step's `dir` is specified and is an

1167

# absolute path, this value is ignored for that step's execution.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1168

"tagName": "A String", # Regex matching tags to build.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1169

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1170

# The syntax of the regular expressions accepted is the syntax accepted by

1171

# RE2 and described at https://github.com/google/re2/wiki/Syntax

1172

"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the

1173

# project ID requesting the build is assumed.

1174

"repoName": "A String", # Required. Name of the Cloud Source Repository.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1175

"commitSha": "A String", # Explicit commit SHA to build.

1176

"substitutions": { # Substitutions to use in a triggered build.

1177

# Should only be used with RunBuildTrigger

1178

"a_key": "A String",

1179

},

1180

"invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision

1181

# regex.

1182

},

1183

"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.

1184

"object": "A String", # Google Cloud Storage object containing the source.

1185

#

1186

# This object must be a gzipped archive file (`.tar.gz`) containing source to

1187

# build.

1188

"generation": "A String", # Google Cloud Storage generation for the object. If the generation is

1189

# omitted, the latest generation will be used.

1190

"bucket": "A String", # Google Cloud Storage bucket containing the source (see

1191

# [Bucket Name

1192

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1193

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1194

},

1195

"options": { # Optional arguments to enable specific features of builds. # Special options for this build.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1196

"logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud

1197

# Storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1198

"env": [ # A list of global environment variable definitions that will exist for all

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1199

# build steps in this build. If a variable is defined in both globally and in

1200

# a build step, the variable will use the build step value.

1201

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1202

# The elements are of the form "KEY=VALUE" for the environment variable "KEY"

1203

# being given the value "VALUE".

1204

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1205

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1206

"workerPool": "A String", # Option to specify a `WorkerPool` for the build.

1207

# Format: projects/{project}/workerPools/{workerPool}

1208

#

1209

# This field is experimental.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1210

"logging": "A String", # Option to specify the logging mode, which determines where the logs are

1211

# stored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1212

"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution

1213

# checks.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1214

"requestedVerifyOption": "A String", # Requested verifiability options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1215

"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*

1216

# "disk free"; some of the space will be used by the operating system and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1217

# build utilities. Also note that this is the minimum disk size that will be

1218

# allocated for the build -- the build may run with a larger disk than

1219

# requested. At present, the maximum disk size is 1000GB; builds that request

1220

# more than the maximum are rejected with an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1221

"sourceProvenanceHash": [ # Requested hash for SourceProvenance.

1222

"A String",

1223

],

1224

"secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud

1225

# Key Management Service crypto key. These values must be specified in the

1226

# build's `Secret`. These variables will be available to all build steps

1227

# in this build.

1228

"A String",

1229

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1230

"machineType": "A String", # Compute Engine machine type on which to run the build.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1231

"volumes": [ # Global list of volumes to mount for ALL build steps

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1232

#

1233

# Each volume is created as an empty volume prior to starting the build

1234

# process. Upon completion of the build, volumes and their contents are

1235

# discarded. Global volume names and paths cannot conflict with the volumes

1236

# defined a build step.

1237

#

1238

# Using a global volume in a build with only one step is not valid as

1239

# it is indicative of a build request with an incorrect configuration.

1240

{ # Volume describes a Docker container volume which is mounted into build steps

1241

# in order to persist files across build step execution.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1242

"path": "A String", # Path at which to mount the volume.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1243

#

1244

# Paths must be absolute and cannot conflict with other volume paths on the

1245

# same build step or with certain reserved volume paths.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1246

"name": "A String", # Name of the volume to mount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1247

#

1248

# Volume names must be unique per build step and must be valid names for

1249

# Docker volumes. Each named volume must be used by at least two build steps.

1250

},

1251

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1252

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1253

"timeout": "A String", # Amount of time that this build should be allowed to run, to second

1254

# granularity. If this amount of time elapses, work on the build will cease

1255

# and the build status will be `TIMEOUT`.

1256

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1257

# `timeout` starts ticking from `startTime`.

1258

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1259

# Default time is ten minutes.

1260

"status": "A String", # Output only. Status of the build.

1261

"statusDetail": "A String", # Output only. Customer-readable message about the current status.

1262

"artifacts": { # Artifacts produced by a build that should be uploaded upon # Artifacts produced by the build that should be uploaded upon

1263

# successful completion of all build steps.

1264

# successful completion of all build steps.

1265

"objects": { # Files in the workspace to upload to Cloud Storage upon successful # A list of objects to be uploaded to Cloud Storage upon successful

1266

# completion of all build steps.

1267

#

1268

# Files in the workspace matching specified paths globs will be uploaded to

1269

# the specified Cloud Storage location using the builder service account's

1270

# credentials.

1271

#

1272

# The location and generation of the uploaded objects will be stored in the

1273

# Build resource's results field.

1274

#

1275

# If any objects fail to be pushed, the build is marked FAILURE.

1276

# completion of all build steps.

1277

"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.

1278

"endTime": "A String", # End of time span.

1279

"startTime": "A String", # Start of time span.

1280

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1281

"location": "A String", # Cloud Storage bucket and optional object path, in the form

1282

# "gs://bucket/path/to/somewhere/". (see [Bucket Name

1283

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1284

#

1285

# Files in the workspace matching any path pattern will be uploaded to

1286

# Cloud Storage with this location as a prefix.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1287

"paths": [ # Path globs used to match files in the build's workspace.

1288

"A String",

1289

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1290

},

1291

"images": [ # A list of images to be pushed upon the successful completion of all build

1292

# steps.

1293

#

1294

# The images will be pushed using the builder service account's credentials.

1295

#

1296

# The digests of the pushed images will be stored in the Build resource's

1297

# results field.

1298

#

1299

# If any of the images fail to be pushed, the build is marked FAILURE.

"A String",

],

},

"secrets": [ # Secrets to decrypt using Cloud Key Management Service.

1304

{ # Pairs a set of secret environment variables containing encrypted

1305

# values with the Cloud KMS key to use to decrypt the value.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1306

"kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1307

"secretEnv": { # Map of environment variable name to its encrypted value.

1308

#

1309

# Secret environment variables must be unique across all of a build's

1310

# secrets, and must be used by at least one build step. Values can be at most

1311

# 64 KB in size. There can be at most 100 secret values across all of a

1312

# build's secrets.

1313

"a_key": "A String",

1314

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1315

},

1316

],

1317

"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1318

"numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.

1319

"artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1320

"buildStepImages": [ # List of build step digests, in the order corresponding to build step

# indices.

"A String",

],

"artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts.

1325

"endTime": "A String", # End of time span.

1326

"startTime": "A String", # Start of time span.

1327

},

1328

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order

1329

# corresponding to build step indices.

1330

#

1331

# [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)

1332

# can produce this output by writing to `$BUILDER_OUTPUT/output`.

1333

# Only the first 4KB of data is stored.

1334

"A String",

1335

],

1336

"images": [ # Container images that were built as a part of the build.

1337

{ # An image built by the pipeline.

1338

"name": "A String", # Name used to push the container image to Google Container Registry, as

1339

# presented to `docker push`.

1340

"digest": "A String", # Docker Registry 2.0 digest.

1341

"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.

1342

"endTime": "A String", # End of time span.

1343

"startTime": "A String", # Start of time span.

1344

},

1345

},

1346

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1347

},

1348

"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see

1349

# [Bucket Name

1350

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1351

# Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.

1352

"steps": [ # Required. The operations to be performed on the workspace.

1353

{ # A step in the build pipeline.

1354

"entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint.

1355

# If unset, the image's default entrypoint is used.

1356

"volumes": [ # List of volumes to mount into the build step.

1357

#

1358

# Each volume is created as an empty volume prior to execution of the

1359

# build step. Upon completion of the build, volumes and their contents are

1360

# discarded.

1361

#

1362

# Using a named volume in only one step is not valid as it is indicative

1363

# of a build request with an incorrect configuration.

1364

{ # Volume describes a Docker container volume which is mounted into build steps

1365

# in order to persist files across build step execution.

1366

"path": "A String", # Path at which to mount the volume.

1367

#

1368

# Paths must be absolute and cannot conflict with other volume paths on the

1369

# same build step or with certain reserved volume paths.

1370

"name": "A String", # Name of the volume to mount.

1371

#

1372

# Volume names must be unique per build step and must be valid names for

1373

# Docker volumes. Each named volume must be used by at least two build steps.

1374

},

1375

],

1376

"args": [ # A list of arguments that will be presented to the step when it is started.

1377

#

1378

# If the image used to run the step's container has an entrypoint, the `args`

1379

# are used as arguments to that entrypoint. If the image does not define

1380

# an entrypoint, the first element in args is used as the entrypoint,

1381

# and the remainder will be used as arguments.

1382

"A String",

1383

],

1384

"status": "A String", # Output only. Status of the build step. At this time, build step status is

1385

# only updated on build completion; step status is not updated in real-time

1386

# as the build progresses.

1387

"timeout": "A String", # Time limit for executing this build step. If not defined, the step has no

1388

# time limit and will be allowed to continue to run until either it completes

1389

# or the build itself times out.

1390

"pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's

1391

# builder image only.

1392

"endTime": "A String", # End of time span.

1393

"startTime": "A String", # Start of time span.

1394

},

1395

"name": "A String", # Required. The name of the container image that will run this particular

1396

# build step.

1397

#

1398

# If the image is available in the host's Docker daemon's cache, it

1399

# will be run directly. If not, the host will attempt to pull the image

1400

# first, using the builder service account's credentials if necessary.

1401

#

1402

# The Docker daemon's cache will already have the latest versions of all of

1403

# the officially supported build steps

1404

# ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).

1405

# The Docker daemon will also have cached many of the layers for some popular

1406

# images, like "ubuntu", "debian", but they will be refreshed at the time you

1407

# attempt to use them.

1408

#

1409

# If you built an image in a previous build step, it will be stored in the

1410

# host's Docker daemon's cache and is available to use as the name for a

1411

# later build step.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1412

"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key

1413

# Management Service crypto key. These values must be specified in the

1414

# build's `Secret`.

1415

"A String",

1416

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1417

"id": "A String", # Unique identifier for this build step, used in `wait_for` to

1418

# reference this build step as a dependency.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1419

"dir": "A String", # Working directory to use when running this step's container.

1420

#

1421

# If this value is a relative path, it is relative to the build's working

1422

# directory. If this value is absolute, it may be outside the build's working

1423

# directory, in which case the contents of the path may not be persisted

1424

# across build step executions, unless a `volume` for that path is specified.

1425

#

1426

# If the build specifies a `RepoSource` with `dir` and a step with a `dir`,

1427

# which specifies an absolute path, the `RepoSource` `dir` is ignored for

1428

# the step's execution.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1429

"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.

1430

"endTime": "A String", # End of time span.

1431

"startTime": "A String", # Start of time span.

1432

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1433

"waitFor": [ # The ID(s) of the step(s) that this build step depends on.

1434

# This build step will not start until all the build steps in `wait_for`

1435

# have completed successfully. If `wait_for` is empty, this build step will

1436

# start when all previous build steps in the `Build.Steps` list have

1437

# completed successfully.

1438

"A String",

1439

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1440

"env": [ # A list of environment variable definitions to be used when running a step.

1441

#

1442

# The elements are of the form "KEY=VALUE" for the environment variable "KEY"

1443

# being given the value "VALUE".

1444

"A String",

1445

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1446

},

1447

],

1448

"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it

1449

# was triggered automatically.

1450

"id": "A String", # Output only. Unique identifier of the build.

1451

"tags": [ # Tags for annotation of a `Build`. These are not docker tags.

1452

"A String",

1453

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1458

<code class="details" id="list">list(projectId, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1459

<pre>Lists previously requested builds.

1460

1461

Previously requested builds may still be in-progress, or may have finished

1462

successfully or unsuccessfully.

1463

1464

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1465

projectId: string, Required. ID of the project. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1466

filter: string, The raw filter text to constrain the results.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1467

pageToken: string, Token to provide to skip to a particular spot in the list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1468

pageSize: integer, Number of results to return in the list.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1469

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1476

1477

{ # Response including listed builds.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1478

"nextPageToken": "A String", # Token to receive the next page of results.

1479

"builds": [ # Builds will be sorted by `create_time`, descending.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1480

{ # A build resource in the Cloud Build API.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1481

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1482

# At a high level, a `Build` describes where to find source code, how to build

1483

# it (for example, the builder image to run on the source), and where to store

1484

# the built artifacts.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1485

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1486

# Fields can include the following variables, which will be expanded when the

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1487

# build is created:

1488

#

1489

# - $PROJECT_ID: the project ID of the build.

1490

# - $BUILD_ID: the autogenerated ID of the build.

1491

# - $REPO_NAME: the source repository name specified by RepoSource.

1492

# - $BRANCH_NAME: the branch name specified by RepoSource.

1493

# - $TAG_NAME: the tag name specified by RepoSource.

1494

# - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or

1495

# resolved from the specified branch or tag.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1496

# - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1497

"startTime": "A String", # Output only. Time at which execution of the build was started.

1498

"substitutions": { # Substitutions data for `Build` resource.

1499

"a_key": "A String",

1500

},

1501

"timing": { # Output only. Stores timing information for phases of the build. Valid keys

1502

# are:

1503

#

1504

# * BUILD: time to execute all build steps

1505

# * PUSH: time to push all specified images.

1506

# * FETCHSOURCE: time to fetch source.

1507

#

1508

# If the build does not specify source or images,

1509

# these keys will not be included.

1510

"a_key": { # Start and end times for a build execution phase.

1511

"endTime": "A String", # End of time span.

1512

"startTime": "A String", # Start of time span.

1513

},

1514

},

1515

"createTime": "A String", # Output only. Time at which the request to create the build was received.

1516

"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # Output only. A permanent fixed identifier for source.

1517

# some source was used for this build.

1518

"fileHashes": { # Output only. Hash(es) of the build source, which can be used to verify that

1519

# the original source integrity was maintained in the build. Note that

1520

# `FileHashes` will only be populated if `BuildOptions` has requested a

1521

# `SourceProvenanceHash`.

1522

#

1523

# The keys to this map are file paths used as build source and the values

1524

# contain the hash values for those files.

1525

#

1526

# If the build source came in a single package such as a gzipped tarfile

1527

# (`.tar.gz`), the `FileHash` will be for the single path to that file.

1528

"a_key": { # Container message for hashes of byte content of files, used in

1529

# SourceProvenance messages to verify integrity of source input to the build.

1530

"fileHash": [ # Collection of file hashes.

1531

{ # Container message for hash values.

1532

"type": "A String", # The type of hash that was performed.

1533

"value": "A String", # The hash value.

},

],

},

},

"resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any

1539

# revisions resolved.

1540

"branchName": "A String", # Regex matching branches to build.

1541

#

1542

# The syntax of the regular expressions accepted is the syntax accepted by

1543

# RE2 and described at https://github.com/google/re2/wiki/Syntax

1544

"dir": "A String", # Directory, relative to the source root, in which to run the build.

1545

#

1546

# This must be a relative path. If a step's `dir` is specified and is an

1547

# absolute path, this value is ignored for that step's execution.

1548

"tagName": "A String", # Regex matching tags to build.

1549

#

1550

# The syntax of the regular expressions accepted is the syntax accepted by

1551

# RE2 and described at https://github.com/google/re2/wiki/Syntax

1552

"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the

1553

# project ID requesting the build is assumed.

1554

"repoName": "A String", # Required. Name of the Cloud Source Repository.

1555

"commitSha": "A String", # Explicit commit SHA to build.

1556

"substitutions": { # Substitutions to use in a triggered build.

1557

# Should only be used with RunBuildTrigger

1558

"a_key": "A String",

1559

},

1560

"invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision

1561

# regex.

1562

},

1563

"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

1564

# generations resolved.

1565

"object": "A String", # Google Cloud Storage object containing the source.

1566

#

1567

# This object must be a gzipped archive file (`.tar.gz`) containing source to

1568

# build.

1569

"generation": "A String", # Google Cloud Storage generation for the object. If the generation is

1570

# omitted, the latest generation will be used.

1571

"bucket": "A String", # Google Cloud Storage bucket containing the source (see

1572

# [Bucket Name

1573

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1574

},

1575

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1576

"images": [ # A list of images to be pushed upon the successful completion of all build

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1577

# steps.

1578

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1579

# The images are pushed using the builder service account's credentials.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1580

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1581

# The digests of the pushed images will be stored in the `Build` resource's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1582

# results field.

1583

#

1584

# If any of the images fail to be pushed, the build status is marked

1585

# `FAILURE`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1586

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1587

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1588

"projectId": "A String", # Output only. ID of the project.

1589

"logUrl": "A String", # Output only. URL to logs for this build in Google Cloud Console.

1590

"queueTtl": "A String", # TTL in queue for this build. If provided and the build is enqueued longer

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1591

# than this value, the build will expire and the build status will be

1592

# `EXPIRED`.

1593

#

1594

# The TTL starts ticking from create_time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1595

"finishTime": "A String", # Output only. Time at which execution of the build was finished.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1596

#

1597

# The difference between finish_time and start_time is the duration of the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1598

# build's execution.

1599

"source": { # Location of the source in a supported storage service. # The location of the source files to build.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1600

"repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source

1601

# Repository.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1602

"branchName": "A String", # Regex matching branches to build.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1603

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1604

# The syntax of the regular expressions accepted is the syntax accepted by

1605

# RE2 and described at https://github.com/google/re2/wiki/Syntax

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1606

"dir": "A String", # Directory, relative to the source root, in which to run the build.

1607

#

1608

# This must be a relative path. If a step's `dir` is specified and is an

1609

# absolute path, this value is ignored for that step's execution.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1610

"tagName": "A String", # Regex matching tags to build.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1611

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1612

# The syntax of the regular expressions accepted is the syntax accepted by

1613

# RE2 and described at https://github.com/google/re2/wiki/Syntax

1614

"projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the

1615

# project ID requesting the build is assumed.

1616

"repoName": "A String", # Required. Name of the Cloud Source Repository.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1617

"commitSha": "A String", # Explicit commit SHA to build.

1618

"substitutions": { # Substitutions to use in a triggered build.

1619

# Should only be used with RunBuildTrigger

1620

"a_key": "A String",

1621

},

1622

"invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision

1623

# regex.

1624

},

1625

"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.

1626

"object": "A String", # Google Cloud Storage object containing the source.

1627

#

1628

# This object must be a gzipped archive file (`.tar.gz`) containing source to

1629

# build.

1630

"generation": "A String", # Google Cloud Storage generation for the object. If the generation is

1631

# omitted, the latest generation will be used.

1632

"bucket": "A String", # Google Cloud Storage bucket containing the source (see

1633

# [Bucket Name

1634

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1635

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1636

},

1637

"options": { # Optional arguments to enable specific features of builds. # Special options for this build.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1638

"logStreamingOption": "A String", # Option to define build log streaming behavior to Google Cloud

1639

# Storage.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1640

"env": [ # A list of global environment variable definitions that will exist for all

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1641

# build steps in this build. If a variable is defined in both globally and in

1642

# a build step, the variable will use the build step value.

1643

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1644

# The elements are of the form "KEY=VALUE" for the environment variable "KEY"

1645

# being given the value "VALUE".

1646

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1647

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1648

"workerPool": "A String", # Option to specify a `WorkerPool` for the build.

1649

# Format: projects/{project}/workerPools/{workerPool}

1650

#

1651

# This field is experimental.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1652

"logging": "A String", # Option to specify the logging mode, which determines where the logs are

1653

# stored.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1654

"substitutionOption": "A String", # Option to specify behavior when there is an error in the substitution

1655

# checks.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1656

"requestedVerifyOption": "A String", # Requested verifiability options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1657

"diskSizeGb": "A String", # Requested disk size for the VM that runs the build. Note that this is *NOT*

1658

# "disk free"; some of the space will be used by the operating system and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1659

# build utilities. Also note that this is the minimum disk size that will be

1660

# allocated for the build -- the build may run with a larger disk than

1661

# requested. At present, the maximum disk size is 1000GB; builds that request

1662

# more than the maximum are rejected with an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1663

"sourceProvenanceHash": [ # Requested hash for SourceProvenance.

1664

"A String",

1665

],

1666

"secretEnv": [ # A list of global environment variables, which are encrypted using a Cloud

1667

# Key Management Service crypto key. These values must be specified in the

1668

# build's `Secret`. These variables will be available to all build steps

1669

# in this build.

1670

"A String",

1671

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1672

"machineType": "A String", # Compute Engine machine type on which to run the build.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1673

"volumes": [ # Global list of volumes to mount for ALL build steps

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1674

#

1675

# Each volume is created as an empty volume prior to starting the build

1676

# process. Upon completion of the build, volumes and their contents are

1677

# discarded. Global volume names and paths cannot conflict with the volumes

1678

# defined a build step.

1679

#

1680

# Using a global volume in a build with only one step is not valid as

1681

# it is indicative of a build request with an incorrect configuration.

1682

{ # Volume describes a Docker container volume which is mounted into build steps

1683

# in order to persist files across build step execution.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1684

"path": "A String", # Path at which to mount the volume.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1685

#

1686

# Paths must be absolute and cannot conflict with other volume paths on the

1687

# same build step or with certain reserved volume paths.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1688

"name": "A String", # Name of the volume to mount.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1689

#

1690

# Volume names must be unique per build step and must be valid names for

1691

# Docker volumes. Each named volume must be used by at least two build steps.

1692

},

1693

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1694

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1695

"timeout": "A String", # Amount of time that this build should be allowed to run, to second

1696

# granularity. If this amount of time elapses, work on the build will cease

1697

# and the build status will be `TIMEOUT`.

1698

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1699

# `timeout` starts ticking from `startTime`.

1700

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1701

# Default time is ten minutes.

1702

"status": "A String", # Output only. Status of the build.

1703

"statusDetail": "A String", # Output only. Customer-readable message about the current status.

1704

"artifacts": { # Artifacts produced by a build that should be uploaded upon # Artifacts produced by the build that should be uploaded upon

1705

# successful completion of all build steps.

1706

# successful completion of all build steps.

1707

"objects": { # Files in the workspace to upload to Cloud Storage upon successful # A list of objects to be uploaded to Cloud Storage upon successful

1708

# completion of all build steps.

1709

#

1710

# Files in the workspace matching specified paths globs will be uploaded to

1711

# the specified Cloud Storage location using the builder service account's

1712

# credentials.

1713

#

1714

# The location and generation of the uploaded objects will be stored in the

1715

# Build resource's results field.

1716

#

1717

# If any objects fail to be pushed, the build is marked FAILURE.

1718

# completion of all build steps.

1719

"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing all artifact objects.

1720

"endTime": "A String", # End of time span.

1721

"startTime": "A String", # Start of time span.

1722

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1723

"location": "A String", # Cloud Storage bucket and optional object path, in the form

1724

# "gs://bucket/path/to/somewhere/". (see [Bucket Name

1725

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1726

#

1727

# Files in the workspace matching any path pattern will be uploaded to

1728

# Cloud Storage with this location as a prefix.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1729

"paths": [ # Path globs used to match files in the build's workspace.

1730

"A String",

1731

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1732

},

1733

"images": [ # A list of images to be pushed upon the successful completion of all build

1734

# steps.

1735

#

1736

# The images will be pushed using the builder service account's credentials.

1737

#

1738

# The digests of the pushed images will be stored in the Build resource's

1739

# results field.

1740

#

1741

# If any of the images fail to be pushed, the build is marked FAILURE.

"A String",

],

},

"secrets": [ # Secrets to decrypt using Cloud Key Management Service.

1746

{ # Pairs a set of secret environment variables containing encrypted

1747

# values with the Cloud KMS key to use to decrypt the value.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1748

"kmsKeyName": "A String", # Cloud KMS key name to use to decrypt these envs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"secretEnv": { # Map of environment variable name to its encrypted value.

1750

#

1751

# Secret environment variables must be unique across all of a build's

1752

# secrets, and must be used by at least one build step. Values can be at most

1753

# 64 KB in size. There can be at most 100 secret values across all of a

1754

# build's secrets.

1755

"a_key": "A String",

1756

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1757

},

1758

],

1759

"results": { # Artifacts created by the build pipeline. # Output only. Results of the build.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1760

"numArtifacts": "A String", # Number of artifacts uploaded. Only populated when artifacts are uploaded.

1761

"artifactManifest": "A String", # Path to the artifact manifest. Only populated when artifacts are uploaded.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1762

"buildStepImages": [ # List of build step digests, in the order corresponding to build step

# indices.

"A String",

],

"artifactTiming": { # Start and end times for a build execution phase. # Time to push all non-container artifacts.

1767

"endTime": "A String", # End of time span.

1768

"startTime": "A String", # Start of time span.

1769

},

1770

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order

1771

# corresponding to build step indices.

1772

#

1773

# [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)

1774

# can produce this output by writing to `$BUILDER_OUTPUT/output`.

1775

# Only the first 4KB of data is stored.

1776

"A String",

1777

],

1778

"images": [ # Container images that were built as a part of the build.

1779

{ # An image built by the pipeline.

1780

"name": "A String", # Name used to push the container image to Google Container Registry, as

1781

# presented to `docker push`.

1782

"digest": "A String", # Docker Registry 2.0 digest.

1783

"pushTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pushing the specified image.

1784

"endTime": "A String", # End of time span.

1785

"startTime": "A String", # Start of time span.

1786

},

1787

},

1788

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1789

},

1790

"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see

1791

# [Bucket Name

1792

# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1793

# Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.

1794

"steps": [ # Required. The operations to be performed on the workspace.

1795

{ # A step in the build pipeline.

1796

"entrypoint": "A String", # Entrypoint to be used instead of the build step image's default entrypoint.

1797

# If unset, the image's default entrypoint is used.

1798

"volumes": [ # List of volumes to mount into the build step.

1799

#

1800

# Each volume is created as an empty volume prior to execution of the

1801

# build step. Upon completion of the build, volumes and their contents are

1802

# discarded.

1803

#

1804

# Using a named volume in only one step is not valid as it is indicative

1805

# of a build request with an incorrect configuration.

1806

{ # Volume describes a Docker container volume which is mounted into build steps

1807

# in order to persist files across build step execution.

1808

"path": "A String", # Path at which to mount the volume.

1809

#

1810

# Paths must be absolute and cannot conflict with other volume paths on the

1811

# same build step or with certain reserved volume paths.

1812

"name": "A String", # Name of the volume to mount.

1813

#

1814

# Volume names must be unique per build step and must be valid names for

1815

# Docker volumes. Each named volume must be used by at least two build steps.

1816

},

1817

],

1818

"args": [ # A list of arguments that will be presented to the step when it is started.

1819

#

1820

# If the image used to run the step's container has an entrypoint, the `args`

1821

# are used as arguments to that entrypoint. If the image does not define

1822

# an entrypoint, the first element in args is used as the entrypoint,

1823

# and the remainder will be used as arguments.

1824

"A String",

1825

],

1826

"status": "A String", # Output only. Status of the build step. At this time, build step status is

1827

# only updated on build completion; step status is not updated in real-time

1828

# as the build progresses.

1829

"timeout": "A String", # Time limit for executing this build step. If not defined, the step has no

1830

# time limit and will be allowed to continue to run until either it completes

1831

# or the build itself times out.

1832

"pullTiming": { # Start and end times for a build execution phase. # Output only. Stores timing information for pulling this build step's

1833

# builder image only.

1834

"endTime": "A String", # End of time span.

1835

"startTime": "A String", # Start of time span.

1836

},

1837

"name": "A String", # Required. The name of the container image that will run this particular

1838

# build step.

1839

#

1840

# If the image is available in the host's Docker daemon's cache, it

1841

# will be run directly. If not, the host will attempt to pull the image

1842

# first, using the builder service account's credentials if necessary.

1843

#

1844

# The Docker daemon's cache will already have the latest versions of all of

1845

# the officially supported build steps

1846

# ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).

1847

# The Docker daemon will also have cached many of the layers for some popular

1848

# images, like "ubuntu", "debian", but they will be refreshed at the time you

1849

# attempt to use them.

1850

#

1851

# If you built an image in a previous build step, it will be stored in the

1852

# host's Docker daemon's cache and is available to use as the name for a

1853

# later build step.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1854

"secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key

1855

# Management Service crypto key. These values must be specified in the

1856

# build's `Secret`.

1857

"A String",

1858

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1859

"id": "A String", # Unique identifier for this build step, used in `wait_for` to

1860

# reference this build step as a dependency.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1861

"dir": "A String", # Working directory to use when running this step's container.

1862

#

1863

# If this value is a relative path, it is relative to the build's working

1864

# directory. If this value is absolute, it may be outside the build's working

1865

# directory, in which case the contents of the path may not be persisted

1866

# across build step executions, unless a `volume` for that path is specified.

1867

#

1868

# If the build specifies a `RepoSource` with `dir` and a step with a `dir`,

1869

# which specifies an absolute path, the `RepoSource` `dir` is ignored for

1870

# the step's execution.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1871

"timing": { # Start and end times for a build execution phase. # Output only. Stores timing information for executing this build step.

1872

"endTime": "A String", # End of time span.

1873

"startTime": "A String", # Start of time span.

1874

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1875

"waitFor": [ # The ID(s) of the step(s) that this build step depends on.

1876

# This build step will not start until all the build steps in `wait_for`

1877

# have completed successfully. If `wait_for` is empty, this build step will

1878

# start when all previous build steps in the `Build.Steps` list have

1879

# completed successfully.

1880

"A String",

1881

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1882

"env": [ # A list of environment variable definitions to be used when running a step.

1883

#

1884

# The elements are of the form "KEY=VALUE" for the environment variable "KEY"

1885

# being given the value "VALUE".

1886

"A String",

1887

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1888

},

1889

],

1890

"buildTriggerId": "A String", # Output only. The ID of the `BuildTrigger` that triggered this build, if it

1891

# was triggered automatically.

1892

"id": "A String", # Output only. Unique identifier of the build.

1893

"tags": [ # Tags for annotation of a `Build`. These are not docker tags.

1894

"A String",

1895

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1903

<pre>Retrieves the next page of results.

1904

1905

Args:

1906

previous_request: The request for the previous page. (required)

1907

previous_response: The response from the request for the previous page. (required)

1908

1909

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1910

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

1911

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1915

1916

<code class="details" id="retry">retry(projectId, id, body=None, x__xgafv=None)</code>

1917

<pre>Creates a new build based on the specified build.

1918

1919

This method creates a new build using the original build request, which may

1920

or may not result in an identical build.

1921

1922

For triggered builds:

1923

1924

* Triggered builds resolve to a precise revision; therefore a retry of a

1925

triggered build will result in a build that uses the same revision.

1926

1927

For non-triggered builds that specify `RepoSource`:

1928

1929

* If the original build built from the tip of a branch, the retried build

1930

will build from the tip of that branch, which may not be the same revision

1931

as the original build.

1932

* If the original build specified a commit sha or revision ID, the retried

1933

build will use the identical source.

1934

1935

For builds that specify `StorageSource`:

1936

1937

* If the original build pulled source from Google Cloud Storage without

1938

specifying the generation of the object, the new build will use the current

1939

object, which may be different from the original build source.

1940

* If the original build pulled source from Cloud Storage and specified the

1941

generation of the object, the new build will attempt to use the same

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1942

object, which may or may not be available depending on the bucket's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1943

lifecycle management settings.

1944

1945

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1946

projectId: string, Required. ID of the project. (required)

1947

id: string, Required. Build ID of the original build. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1948

body: object, The request body.

1949

The object takes the form of:

1950

1951

{ # Specifies a build to retry.

1952

}

1953

1954

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1961

1962

{ # This resource represents a long-running operation that is the result of a

1963

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1964

"name": "A String", # The server-assigned name, which is only unique within the same service that

1965

# originally returns it. If you use the default HTTP mapping, the

1966

# `name` should be a resource name ending with `operations/{unique_id}`.

1967

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

1968

# different programming environments, including REST APIs and RPC APIs. It is

1969

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1970

# three pieces of data: error code, error message, and error details.

1971

#

1972

# You can find out more about this error model and how to work with it in the

1973

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1974

"message": "A String", # A developer-facing error message, which should be in English. Any

1975

# user-facing error message should be localized and sent in the

1976

# google.rpc.Status.details field, or localized by the client.

1977

"details": [ # A list of messages that carry the error details. There is a common set of

1978

# message types for APIs to use.

1979

{

1980

"a_key": "", # Properties of the object. Contains field @type with type URL.

1981

},

1982

],

1983

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1984

},

1985

"metadata": { # Service-specific metadata associated with the operation. It typically

1986

# contains progress information and common metadata such as create time.

1987

# Some services might not provide such metadata. Any method that returns a

1988

# long-running operation should document the metadata type, if any.

1989

"a_key": "", # Properties of the object. Contains field @type with type URL.

1990

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1991

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1992

# If `true`, the operation is completed, and either `error` or `response` is

1993

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1994

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1995

# method returns no data on success, such as `Delete`, the response is

1996

# `google.protobuf.Empty`. If the original method is standard

1997

# `Get`/`Create`/`Update`, the response should be the resource. For other

1998

# methods, the response should have the type `XxxResponse`, where `Xxx`

1999

# is the original method name. For example, if the original method name

2000

# is `TakeSnapshot()`, the inferred response type is

2001

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2002

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2003

},

Bu Sun Kim