v1beta1.d.ts
68.2 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
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace cloudbuild_v1beta1 {
export interface Options extends GlobalOptions {
version: 'v1beta1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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
* ```js
* const {google} = require('googleapis');
* const cloudbuild = google.cloudbuild('v1beta1');
* ```
*/
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. - $PROJECT_NUMBER: the project number 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;
/**
* Secrets and secret environment variables.
*/
availableSecrets?: Schema$Secrets;
/**
* 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;
/**
* Output only. The 'Build' name with format: `projects/{project\}/locations/{location\}/builds/{build\}`, where {build\} is a unique identifier generated by the service.
*/
name?: string | null;
/**
* Special options for this build.
*/
options?: Schema$BuildOptions;
/**
* Output only. ID of the project.
*/
projectId?: string | null;
/**
* TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time.
*/
queueTtl?: string | null;
/**
* Output only. Results of the build.
*/
results?: Schema$Results;
/**
* Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets
*/
secrets?: Schema$Secret[];
/**
* IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID\}/serviceAccounts/{ACCOUNT\}`. ACCOUNT can be email address or uniqueId of the service account.
*/
serviceAccount?: string | null;
/**
* 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`. `timeout` starts ticking from `startTime`. 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;
/**
* Output only. Non-fatal problems encountered during the execution of the build.
*/
warnings?: Schema$Warning[];
}
/**
* 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;
/**
* Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.
*/
dynamicSubstitutions?: boolean | 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 if and where build 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. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.
*/
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. Format: projects/{project\}/locations/{location\}/workerPools/{workerPool\} This field is in beta and is available only to restricted users.
*/
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;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* 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;
}
/**
* HTTPDelivery is the delivery configuration for an HTTP notification.
*/
export interface Schema$HTTPDelivery {
/**
* The URI to which JSON-containing HTTP POST requests should be sent.
*/
uri?: string | null;
}
/**
* Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
*/
export interface Schema$InlineSecret {
/**
* 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.
*/
envMap?: {
[key: string]: string;
} | null;
/**
* Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/x/locations/x/keyRings/x/cryptoKeys/x
*/
kmsKeyName?: string | null;
}
/**
* Response containing existing `WorkerPools`.
*/
export interface Schema$ListWorkerPoolsResponse {
/**
* `WorkerPools` for the specified project.
*/
workerPools?: Schema$WorkerPool[];
}
/**
* Network describes the network configuration for a `WorkerPool`.
*/
export interface Schema$NetworkConfig {
/**
* Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project\}/global/networks/{network\}`, where `{project\}` is a project number, such as `12345`, and `{network\}` is the name of a VPC network in the project. See [Understanding network configuration options](https://cloud.google.com/cloud-build/docs/custom-workers/set-up-custom-worker-pool-environment#understanding_the_network_configuration_options)
*/
peeredNetwork?: string | null;
}
/**
* Notification is the container which holds the data that is relevant to this particular notification.
*/
export interface Schema$Notification {
/**
* The filter string to use for notification filtering. Currently, this is assumed to be a CEL program. See https://opensource.google/projects/cel for more.
*/
filter?: string | null;
/**
* Configuration for HTTP delivery.
*/
httpDelivery?: Schema$HTTPDelivery;
/**
* Configuration for Slack delivery.
*/
slackDelivery?: Schema$SlackDelivery;
/**
* Configuration for SMTP (email) delivery.
*/
smtpDelivery?: Schema$SMTPDelivery;
/**
* Escape hatch for users to supply custom delivery configs.
*/
structDelivery?: {
[key: string]: any;
} | null;
}
/**
* NotifierConfig is the top-level configuration message.
*/
export interface Schema$NotifierConfig {
/**
* The API version of this configuration format.
*/
apiVersion?: string | null;
/**
* The type of notifier to use (e.g. SMTPNotifier).
*/
kind?: string | null;
/**
* Metadata for referring to/handling/deploying this notifier.
*/
metadata?: Schema$NotifierMetadata;
/**
* The actual configuration for this notifier.
*/
spec?: Schema$NotifierSpec;
}
/**
* NotifierMetadata contains the data which can be used to reference or describe this notifier.
*/
export interface Schema$NotifierMetadata {
/**
* The human-readable and user-given name for the notifier. For example: "repo-merge-email-notifier".
*/
name?: string | null;
/**
* The string representing the name and version of notifier to deploy. Expected to be of the form of "/:". For example: "gcr.io/my-project/notifiers/smtp:1.2.34".
*/
notifier?: string | null;
}
/**
* NotifierSecret is the container that maps a secret name (reference) to its Google Cloud Secret Manager resource path.
*/
export interface Schema$NotifierSecret {
/**
* Name is the local name of the secret, such as the verbatim string "my-smtp-password".
*/
name?: string | null;
/**
* Value is interpreted to be a resource path for fetching the actual (versioned) secret data for this secret. For example, this would be a Google Cloud Secret Manager secret version resource path like: "projects/my-project/secrets/my-secret/versions/latest".
*/
value?: string | null;
}
/**
* NotifierSecretRef contains the reference to a secret stored in the corresponding NotifierSpec.
*/
export interface Schema$NotifierSecretRef {
/**
* The value of `secret_ref` should be a `name` that is registered in a `Secret` in the `secrets` list of the `Spec`.
*/
secretRef?: string | null;
}
/**
* NotifierSpec is the configuration container for notifications.
*/
export interface Schema$NotifierSpec {
/**
* The configuration of this particular notifier.
*/
notification?: Schema$Notification;
/**
* Configurations for secret resources used by this particular notifier.
*/
secrets?: Schema$NotifierSecret[];
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | 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;
/**
* Only trigger a build if the revision regex does NOT match the revision regex.
*/
invertRegex?: boolean | 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.
*/
repoName?: string | null;
/**
* Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
*/
substitutions?: {
[key: string]: 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. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.
*/
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;
}
/**
* Pairs a secret environment variable with a SecretVersion in Secret Manager.
*/
export interface Schema$SecretManagerSecret {
/**
* Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.
*/
env?: string | null;
/**
* Resource name of the SecretVersion. In format: projects/x/secrets/x/versions/x
*/
versionName?: string | null;
}
/**
* Secrets and secret environment variables.
*/
export interface Schema$Secrets {
/**
* Secrets encrypted with KMS key and the associated secret environment variable.
*/
inline?: Schema$InlineSecret[];
/**
* Secrets in Secret Manager and associated secret environment variable.
*/
secretManager?: Schema$SecretManagerSecret[];
}
/**
* SlackDelivery is the delivery configuration for delivering Slack messages via webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/webhooks.
*/
export interface Schema$SlackDelivery {
/**
* The secret reference for the Slack webhook URI for sending messages to a channel.
*/
webhookUri?: Schema$NotifierSecretRef;
}
/**
* SMTPDelivery is the delivery configuration for an SMTP (email) notification.
*/
export interface Schema$SMTPDelivery {
/**
* This is the SMTP account/email that appears in the `From:` of the email. If empty, it is assumed to be sender.
*/
fromAddress?: string | null;
/**
* The SMTP sender's password.
*/
password?: Schema$NotifierSecretRef;
/**
* The SMTP port of the server.
*/
port?: string | null;
/**
* This is the list of addresses to which we send the email (i.e. in the `To:` of the email).
*/
recipientAddresses?: string[] | null;
/**
* This is the SMTP account/email that is used to send the message.
*/
senderAddress?: string | null;
/**
* The address of the SMTP server.
*/
server?: 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;
/**
* If provided, get the source from this manifest in Google Cloud Storage. This feature is in Preview.
*/
storageSourceManifest?: Schema$StorageSourceManifest;
}
/**
* 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;
/**
* A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview.
*/
resolvedStorageSourceManifest?: Schema$StorageSourceManifest;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* 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;
}
/**
* Location of the source manifest in Google Cloud Storage. This feature is in Preview.
*/
export interface Schema$StorageSourceManifest {
/**
* Google Cloud Storage bucket containing the source manifest (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 manifest. This object must be a JSON file.
*/
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;
}
/**
* A non-fatal problem encountered during the execution of the build.
*/
export interface Schema$Warning {
/**
* The priority for this warning.
*/
priority?: string | null;
/**
* Explanation of the warning generated.
*/
text?: string | null;
}
/**
* Defines the configuration to be used for creating workers in the pool.
*/
export interface Schema$WorkerConfig {
/**
* Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/cloud-build/docs/custom-workers/worker-pool-config-file). Specify a value of up to 1000. If `0` is specified, Cloud Build will use a standard disk size.
*/
diskSizeGb?: string | null;
/**
* Machine type of a worker, such as `n1-standard-1`. See [Worker pool config file](https://cloud.google.com/cloud-build/docs/custom-workers/worker-pool-config-file). If left blank, Cloud Build will use `n1-standard-1`.
*/
machineType?: string | null;
/**
* If true, workers are created without any public address, which prevents network egress to public IPs.
*/
noExternalIp?: boolean | null;
}
/**
* Configuration for a `WorkerPool` to run the builds. Workers provide a build environment where Cloud Build runs your builds. Cloud Build owns and maintains a pool of workers for general use. By default, when you submit a build, Cloud Build uses one of the workers from this pool. Builds that run in the default worker pool have access to the public internet. If your build needs access to resources on a private network, create and use a `WorkerPool` to run your builds. Custom `WorkerPool`s give your builds access to any single VPC network that you administer, including any on-prem resources connected to that VPC network. For an overview of custom worker pools, see [Custom workers overview](https://cloud.google.com/cloud-build/docs/custom-workers/custom-workers-overview).
*/
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;
/**
* Output only. The resource name of the `WorkerPool`, with format `projects/{project\}/locations/{location\}/workerPools/{worker_pool\}`. The value of `{worker_pool\}` is provided by `worker_pool_id` in `CreateWorkerPool` request and the value of `{location\}` is determined by the endpoint accessed.
*/
name?: string | null;
/**
* Network configuration for the `WorkerPool`.
*/
networkConfig?: Schema$NetworkConfig;
/**
* Output only. `WorkerPool` state.
*/
state?: string | null;
/**
* Output only. Time at which the request to update the `WorkerPool` was received.
*/
updateTime?: string | null;
/**
* Worker configuration for the `WorkerPool`.
*/
workerConfig?: Schema$WorkerConfig;
}
export class Resource$Projects {
context: APIRequestContext;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Locations {
context: APIRequestContext;
operations: Resource$Projects$Locations$Operations;
workerPools: Resource$Projects$Locations$Workerpools;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Locations$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudbuild = google.cloudbuild('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudbuild.projects.locations.operations.cancel({
* // The name of the operation resource to be cancelled.
* name: 'projects/my-project/locations/my-location/operations/my-operation',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions): GaxiosPromise<Readable>;
cancel(params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudbuild = google.cloudbuild('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudbuild.projects.locations.operations.get({
* // The name of the operation resource.
* name: 'projects/my-project/locations/my-location/operations/my-operation',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters {
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CancelOperationRequest;
}
export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters {
/**
* The name of the operation resource.
*/
name?: string;
}
export class Resource$Projects$Locations$Workerpools {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a `WorkerPool` to run the builds, and returns the new worker pool. NOTE: As of now, this method returns an `Operation` that is always complete.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudbuild = google.cloudbuild('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudbuild.projects.locations.workerPools.create({
* // Required. The parent resource where this worker pool will be created. Format: `projects/{project\}/locations/{location\}`.
* parent: 'projects/my-project/locations/my-location',
* // Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.
* workerPoolId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "createTime": "my_createTime",
* // "deleteTime": "my_deleteTime",
* // "name": "my_name",
* // "networkConfig": {},
* // "state": "my_state",
* // "updateTime": "my_updateTime",
* // "workerConfig": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Locations$Workerpools$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Locations$Workerpools$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Locations$Workerpools$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Locations$Workerpools$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Locations$Workerpools$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Deletes a `WorkerPool`. NOTE: As of now, this method returns an `Operation` that is always complete.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudbuild = google.cloudbuild('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudbuild.projects.locations.workerPools.delete({
* // Required. The name of the `WorkerPool` to delete. Format: `projects/{project\}/locations/{workerPool\}/workerPools/{workerPool\}`.
* name: 'projects/my-project/locations/my-location/workerPools/my-workerPool',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Locations$Workerpools$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Locations$Workerpools$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Projects$Locations$Workerpools$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Locations$Workerpools$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Projects$Locations$Workerpools$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Returns details of a `WorkerPool`.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudbuild = google.cloudbuild('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudbuild.projects.locations.workerPools.get({
* // Required. The name of the `WorkerPool` to retrieve. Format: `projects/{project\}/locations/{location\}/workerPools/{workerPool\}`.
* name: 'projects/my-project/locations/my-location/workerPools/my-workerPool',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "deleteTime": "my_deleteTime",
* // "name": "my_name",
* // "networkConfig": {},
* // "state": "my_state",
* // "updateTime": "my_updateTime",
* // "workerConfig": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Workerpools$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Workerpools$Get, options?: MethodOptions): GaxiosPromise<Schema$WorkerPool>;
get(params: Params$Resource$Projects$Locations$Workerpools$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Workerpools$Get, options: MethodOptions | BodyResponseCallback<Schema$WorkerPool>, callback: BodyResponseCallback<Schema$WorkerPool>): void;
get(params: Params$Resource$Projects$Locations$Workerpools$Get, callback: BodyResponseCallback<Schema$WorkerPool>): void;
get(callback: BodyResponseCallback<Schema$WorkerPool>): void;
/**
* Lists `WorkerPool`s in the given project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudbuild = google.cloudbuild('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudbuild.projects.locations.workerPools.list({
* // Required. The parent of the collection of `WorkerPools`. Format: `projects/{project\}/locations/location`.
* parent: 'projects/my-project/locations/my-location',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "workerPools": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Workerpools$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Workerpools$List, options?: MethodOptions): GaxiosPromise<Schema$ListWorkerPoolsResponse>;
list(params: Params$Resource$Projects$Locations$Workerpools$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Workerpools$List, options: MethodOptions | BodyResponseCallback<Schema$ListWorkerPoolsResponse>, callback: BodyResponseCallback<Schema$ListWorkerPoolsResponse>): void;
list(params: Params$Resource$Projects$Locations$Workerpools$List, callback: BodyResponseCallback<Schema$ListWorkerPoolsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListWorkerPoolsResponse>): void;
/**
* Updates a `WorkerPool`. NOTE: As of now, this method returns an `Operation` that is always complete.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudbuild = google.cloudbuild('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudbuild.projects.locations.workerPools.patch({
* // Output only. The resource name of the `WorkerPool`, with format `projects/{project\}/locations/{location\}/workerPools/{worker_pool\}`. The value of `{worker_pool\}` is provided by `worker_pool_id` in `CreateWorkerPool` request and the value of `{location\}` is determined by the endpoint accessed.
* name: 'projects/my-project/locations/my-location/workerPools/my-workerPool',
* // A mask specifying which fields in `WorkerPool` to update.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "createTime": "my_createTime",
* // "deleteTime": "my_deleteTime",
* // "name": "my_name",
* // "networkConfig": {},
* // "state": "my_state",
* // "updateTime": "my_updateTime",
* // "workerConfig": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "metadata": {},
* // "name": "my_name",
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Locations$Workerpools$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Locations$Workerpools$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Projects$Locations$Workerpools$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Locations$Workerpools$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Projects$Locations$Workerpools$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Workerpools$Create extends StandardParameters {
/**
* Required. The parent resource where this worker pool will be created. Format: `projects/{project\}/locations/{location\}`.
*/
parent?: string;
/**
* Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.
*/
workerPoolId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WorkerPool;
}
export interface Params$Resource$Projects$Locations$Workerpools$Delete extends StandardParameters {
/**
* Required. The name of the `WorkerPool` to delete. Format: `projects/{project\}/locations/{workerPool\}/workerPools/{workerPool\}`.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Workerpools$Get extends StandardParameters {
/**
* Required. The name of the `WorkerPool` to retrieve. Format: `projects/{project\}/locations/{location\}/workerPools/{workerPool\}`.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Workerpools$List extends StandardParameters {
/**
* Required. The parent of the collection of `WorkerPools`. Format: `projects/{project\}/locations/location`.
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Workerpools$Patch extends StandardParameters {
/**
* Output only. The resource name of the `WorkerPool`, with format `projects/{project\}/locations/{location\}/workerPools/{worker_pool\}`. The value of `{worker_pool\}` is provided by `worker_pool_id` in `CreateWorkerPool` request and the value of `{location\}` is determined by the endpoint accessed.
*/
name?: string;
/**
* A mask specifying which fields in `WorkerPool` to update.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WorkerPool;
}
export {};
}