v1alpha1.d.ts
38.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace cloudbuild_v1alpha1 {
export interface Options extends GlobalOptions {
version: 'v1alpha1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Build API
*
* Creates and manages builds on Google Cloud Platform.
*
* @example
* const {google} = require('googleapis');
* const cloudbuild = google.cloudbuild('v1alpha1');
*
* @namespace cloudbuild
* @type {Function}
* @version v1alpha1
* @variation v1alpha1
* @param {object=} options Options for Cloudbuild
*/
export class Cloudbuild {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.
*/
export interface Schema$ArtifactObjects {
/**
* Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.
*/
location?: string | null;
/**
* Path globs used to match files in the build's workspace.
*/
paths?: string[] | null;
/**
* Output only. Stores timing information for pushing all artifact objects.
*/
timing?: Schema$TimeSpan;
}
/**
* An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.
*/
export interface Schema$ArtifactResult {
/**
* The file hash of the artifact.
*/
fileHash?: Schema$FileHashes[];
/**
* The path of an artifact in a Google Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`.
*/
location?: string | null;
}
/**
* Artifacts produced by a build that should be uploaded upon successful completion of all build steps.
*/
export interface Schema$Artifacts {
/**
* A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.
*/
images?: string[] | null;
/**
* A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.
*/
objects?: Schema$ArtifactObjects;
}
/**
* A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
*/
export interface Schema$Build {
/**
* Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
*/
artifacts?: Schema$Artifacts;
/**
* Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.
*/
buildTriggerId?: string | null;
/**
* Output only. Time at which the request to create the build was received.
*/
createTime?: string | null;
/**
* Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.
*/
finishTime?: string | null;
/**
* Output only. Unique identifier of the build.
*/
id?: string | null;
/**
* A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.
*/
images?: string[] | null;
/**
* Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
*/
logsBucket?: string | null;
/**
* Output only. URL to logs for this build in Google Cloud Console.
*/
logUrl?: string | null;
/**
* Special options for this build.
*/
options?: Schema$BuildOptions;
/**
* Output only. ID of the project.
*/
projectId?: string | null;
/**
* Output only. Results of the build.
*/
results?: Schema$Results;
/**
* Secrets to decrypt using Cloud Key Management Service.
*/
secrets?: Schema$Secret[];
/**
* The location of the source files to build.
*/
source?: Schema$Source;
/**
* Output only. A permanent fixed identifier for source.
*/
sourceProvenance?: Schema$SourceProvenance;
/**
* Output only. Time at which execution of the build was started.
*/
startTime?: string | null;
/**
* Output only. Status of the build.
*/
status?: string | null;
/**
* Output only. Customer-readable message about the current status.
*/
statusDetail?: string | null;
/**
* Required. The operations to be performed on the workspace.
*/
steps?: Schema$BuildStep[];
/**
* Substitutions data for `Build` resource.
*/
substitutions?: {
[key: string]: string;
} | null;
/**
* Tags for annotation of a `Build`. These are not docker tags.
*/
tags?: string[] | null;
/**
* Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. Default time is ten minutes.
*/
timeout?: string | null;
/**
* Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included.
*/
timing?: {
[key: string]: Schema$TimeSpan;
} | null;
}
/**
* Metadata for build operations.
*/
export interface Schema$BuildOperationMetadata {
/**
* The build that the operation is tracking.
*/
build?: Schema$Build;
}
/**
* Optional arguments to enable specific features of builds.
*/
export interface Schema$BuildOptions {
/**
* Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error.
*/
diskSizeGb?: string | null;
/**
* A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
*/
env?: string[] | null;
/**
* Option to specify the logging mode, which determines where the logs are stored.
*/
logging?: string | null;
/**
* Option to define build log streaming behavior to Google Cloud Storage.
*/
logStreamingOption?: string | null;
/**
* Compute Engine machine type on which to run the build.
*/
machineType?: string | null;
/**
* Requested verifiability options.
*/
requestedVerifyOption?: string | null;
/**
* A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.
*/
secretEnv?: string[] | null;
/**
* Requested hash for SourceProvenance.
*/
sourceProvenanceHash?: string[] | null;
/**
* Option to specify behavior when there is an error in the substitution checks.
*/
substitutionOption?: string | null;
/**
* Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.
*/
volumes?: Schema$Volume[];
/**
* Option to specify a `WorkerPool` for the build. User specifies the pool with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". This is an experimental field.
*/
workerPool?: string | null;
}
/**
* A step in the build pipeline.
*/
export interface Schema$BuildStep {
/**
* A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
*/
args?: string[] | null;
/**
* Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
*/
dir?: string | null;
/**
* Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.
*/
entrypoint?: string | null;
/**
* A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
*/
env?: string[] | null;
/**
* Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
*/
id?: string | null;
/**
* Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
*/
name?: string | null;
/**
* Output only. Stores timing information for pulling this build step's builder image only.
*/
pullTiming?: Schema$TimeSpan;
/**
* A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.
*/
secretEnv?: string[] | null;
/**
* Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.
*/
status?: string | null;
/**
* Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
*/
timeout?: string | null;
/**
* Output only. Stores timing information for executing this build step.
*/
timing?: Schema$TimeSpan;
/**
* List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.
*/
volumes?: Schema$Volume[];
/**
* The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.
*/
waitFor?: string[] | null;
}
/**
* An image built by the pipeline.
*/
export interface Schema$BuiltImage {
/**
* Docker Registry 2.0 digest.
*/
digest?: string | null;
/**
* Name used to push the container image to Google Container Registry, as presented to `docker push`.
*/
name?: string | null;
/**
* Output only. Stores timing information for pushing the specified image.
*/
pushTiming?: Schema$TimeSpan;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {
}
/**
* Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
*/
export interface Schema$FileHashes {
/**
* Collection of file hashes.
*/
fileHash?: Schema$Hash[];
}
/**
* Container message for hash values.
*/
export interface Schema$Hash {
/**
* The type of hash that was performed.
*/
type?: string | null;
/**
* The hash value.
*/
value?: string | null;
}
/**
* Response containing existing `WorkerPools`.
*/
export interface Schema$ListWorkerPoolsResponse {
/**
* `WorkerPools` for the project.
*/
workerPools?: Schema$WorkerPool[];
}
/**
* Network describes the GCP network used to create workers in.
*/
export interface Schema$Network {
/**
* Network on which the workers are created. "default" network is used if empty.
*/
network?: string | null;
/**
* Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
*/
projectId?: string | null;
/**
* Subnetwork on which the workers are created. "default" subnetwork is used if empty.
*/
subnetwork?: string | null;
}
/**
* Location of the source in a Google Cloud Source Repository.
*/
export interface Schema$RepoSource {
/**
* Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
*/
branchName?: string | null;
/**
* Explicit commit SHA to build.
*/
commitSha?: string | null;
/**
* Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
*/
dir?: string | null;
/**
* ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
*/
projectId?: string | null;
/**
* Name of the Cloud Source Repository. If omitted, the name "default" is assumed.
*/
repoName?: string | null;
/**
* Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
*/
tagName?: string | null;
}
/**
* Artifacts created by the build pipeline.
*/
export interface Schema$Results {
/**
* Path to the artifact manifest. Only populated when artifacts are uploaded.
*/
artifactManifest?: string | null;
/**
* Time to push all non-container artifacts.
*/
artifactTiming?: Schema$TimeSpan;
/**
* List of build step digests, in the order corresponding to build step indices.
*/
buildStepImages?: string[] | null;
/**
* List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored.
*/
buildStepOutputs?: string[] | null;
/**
* Container images that were built as a part of the build.
*/
images?: Schema$BuiltImage[];
/**
* Number of artifacts uploaded. Only populated when artifacts are uploaded.
*/
numArtifacts?: string | null;
}
/**
* Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value.
*/
export interface Schema$Secret {
/**
* Cloud KMS key name to use to decrypt these envs.
*/
kmsKeyName?: string | null;
/**
* Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
*/
secretEnv?: {
[key: string]: string;
} | null;
}
/**
* Location of the source in a supported storage service.
*/
export interface Schema$Source {
/**
* If provided, get the source from this location in a Cloud Source Repository.
*/
repoSource?: Schema$RepoSource;
/**
* If provided, get the source from this location in Google Cloud Storage.
*/
storageSource?: Schema$StorageSource;
}
/**
* Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
*/
export interface Schema$SourceProvenance {
/**
* Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.
*/
fileHashes?: {
[key: string]: Schema$FileHashes;
} | null;
/**
* A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
*/
resolvedRepoSource?: Schema$RepoSource;
/**
* A copy of the build's `source.storage_source`, if exists, with any generations resolved.
*/
resolvedStorageSource?: Schema$StorageSource;
}
/**
* Location of the source in an archive file in Google Cloud Storage.
*/
export interface Schema$StorageSource {
/**
* Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
*/
bucket?: string | null;
/**
* Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
*/
generation?: string | null;
/**
* Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
*/
object?: string | null;
}
/**
* Start and end times for a build execution phase.
*/
export interface Schema$TimeSpan {
/**
* End of time span.
*/
endTime?: string | null;
/**
* Start of time span.
*/
startTime?: string | null;
}
/**
* Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
*/
export interface Schema$Volume {
/**
* Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
*/
name?: string | null;
/**
* Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
*/
path?: string | null;
}
/**
* WorkerConfig defines the configuration to be used for a creating workers in the pool.
*/
export interface Schema$WorkerConfig {
/**
* Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
*/
diskSizeGb?: string | null;
/**
* Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
*/
machineType?: string | null;
/**
* The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
*/
network?: Schema$Network;
/**
* The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`.
*/
tag?: string | null;
}
/**
* Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.
*/
export interface Schema$WorkerPool {
/**
* Output only. Time at which the request to create the `WorkerPool` was received.
*/
createTime?: string | null;
/**
* Output only. Time at which the request to delete the `WorkerPool` was received.
*/
deleteTime?: string | null;
/**
* User-defined name of the `WorkerPool`.
*/
name?: string | null;
/**
* The project ID of the GCP project for which the `WorkerPool` is created.
*/
projectId?: string | null;
/**
* List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region.
*/
regions?: string[] | null;
/**
* Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level.
*/
serviceAccountEmail?: string | null;
/**
* Output only. WorkerPool Status.
*/
status?: string | null;
/**
* Output only. Time at which the request to update the `WorkerPool` was received.
*/
updateTime?: string | null;
/**
* Configuration to be used for a creating workers in the `WorkerPool`.
*/
workerConfig?: Schema$WorkerConfig;
/**
* Total number of workers to be created across all requested regions.
*/
workerCount?: string | null;
}
export class Resource$Projects {
context: APIRequestContext;
workerPools: Resource$Projects$Workerpools;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Workerpools {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudbuild.projects.workerPools.create
* @desc Creates a `WorkerPool` to run the builds, and returns the new worker pool. This API is experimental.
* @alias cloudbuild.projects.workerPools.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent ID of the parent project.
* @param {().WorkerPool} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Projects$Workerpools$Create, options?: MethodOptions): GaxiosPromise<Schema$WorkerPool>;
create(params: Params$Resource$Projects$Workerpools$Create, options: MethodOptions | BodyResponseCallback<Schema$WorkerPool>, callback: BodyResponseCallback<Schema$WorkerPool>): void;
create(params: Params$Resource$Projects$Workerpools$Create, callback: BodyResponseCallback<Schema$WorkerPool>): void;
create(callback: BodyResponseCallback<Schema$WorkerPool>): void;
/**
* cloudbuild.projects.workerPools.delete
* @desc Deletes a `WorkerPool` by its project ID and WorkerPool name. This API is experimental.
* @alias cloudbuild.projects.workerPools.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Projects$Workerpools$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Workerpools$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Workerpools$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* cloudbuild.projects.workerPools.get
* @desc Returns information about a `WorkerPool`. This API is experimental.
* @alias cloudbuild.projects.workerPools.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Workerpools$Get, options?: MethodOptions): GaxiosPromise<Schema$WorkerPool>;
get(params: Params$Resource$Projects$Workerpools$Get, options: MethodOptions | BodyResponseCallback<Schema$WorkerPool>, callback: BodyResponseCallback<Schema$WorkerPool>): void;
get(params: Params$Resource$Projects$Workerpools$Get, callback: BodyResponseCallback<Schema$WorkerPool>): void;
get(callback: BodyResponseCallback<Schema$WorkerPool>): void;
/**
* cloudbuild.projects.workerPools.list
* @desc List project's `WorkerPool`s. This API is experimental.
* @alias cloudbuild.projects.workerPools.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent ID of the parent project.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Workerpools$List, options?: MethodOptions): GaxiosPromise<Schema$ListWorkerPoolsResponse>;
list(params: Params$Resource$Projects$Workerpools$List, options: MethodOptions | BodyResponseCallback<Schema$ListWorkerPoolsResponse>, callback: BodyResponseCallback<Schema$ListWorkerPoolsResponse>): void;
list(params: Params$Resource$Projects$Workerpools$List, callback: BodyResponseCallback<Schema$ListWorkerPoolsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListWorkerPoolsResponse>): void;
/**
* cloudbuild.projects.workerPools.patch
* @desc Update a `WorkerPool`. This API is experimental.
* @alias cloudbuild.projects.workerPools.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name"
* @param {().WorkerPool} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Projects$Workerpools$Patch, options?: MethodOptions): GaxiosPromise<Schema$WorkerPool>;
patch(params: Params$Resource$Projects$Workerpools$Patch, options: MethodOptions | BodyResponseCallback<Schema$WorkerPool>, callback: BodyResponseCallback<Schema$WorkerPool>): void;
patch(params: Params$Resource$Projects$Workerpools$Patch, callback: BodyResponseCallback<Schema$WorkerPool>): void;
patch(callback: BodyResponseCallback<Schema$WorkerPool>): void;
}
export interface Params$Resource$Projects$Workerpools$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the parent project.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WorkerPool;
}
export interface Params$Resource$Projects$Workerpools$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name"
*/
name?: string;
}
export interface Params$Resource$Projects$Workerpools$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name"
*/
name?: string;
}
export interface Params$Resource$Projects$Workerpools$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the parent project.
*/
parent?: string;
}
export interface Params$Resource$Projects$Workerpools$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name"
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WorkerPool;
}
export {};
}