/
cloudbuild.proto
2729 lines (2303 loc) · 95 KB
/
cloudbuild.proto
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
// Copyright 2023 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.
syntax = "proto3";
package google.devtools.cloudbuild.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/httpbody.proto";
import "google/api/resource.proto";
import "google/api/routing.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.CloudBuild.V1";
option go_package = "cloud.google.com/go/cloudbuild/apiv1/v2/cloudbuildpb;cloudbuildpb";
option java_multiple_files = true;
option java_package = "com.google.cloudbuild.v1";
option objc_class_prefix = "GCB";
option php_namespace = "Google\\Cloud\\Build\\V1";
option ruby_package = "Google::Cloud::Build::V1";
option (google.api.resource_definition) = {
type: "compute.googleapis.com/Network"
pattern: "projects/{project}/global/networks/{network}"
};
option (google.api.resource_definition) = {
type: "iam.googleapis.com/ServiceAccount"
pattern: "projects/{project}/serviceAccounts/{service_account}"
};
option (google.api.resource_definition) = {
type: "secretmanager.googleapis.com/Secret"
pattern: "projects/{project}/secrets/{secret}"
};
option (google.api.resource_definition) = {
type: "secretmanager.googleapis.com/SecretVersion"
pattern: "projects/{project}/secrets/{secret}/versions/{version}"
};
option (google.api.resource_definition) = {
type: "gkehub.googleapis.com/Membership"
pattern: "projects/{project}/locations/{location}/memberships/{cluster_name}"
};
option (google.api.resource_definition) = {
type: "cloudkms.googleapis.com/CryptoKey"
pattern: "projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}"
};
option (google.api.resource_definition) = {
type: "pubsub.googleapis.com/Subscription"
pattern: "projects/{project}/subscriptions/{subscription}"
};
option (google.api.resource_definition) = {
type: "pubsub.googleapis.com/Topic"
pattern: "projects/{project}/topics/{topic}"
};
option (google.api.resource_definition) = {
type: "cloudbuild.googleapis.com/Repository"
pattern: "projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}"
};
// Creates and manages builds on Google Cloud Platform.
//
// The main concept used by this API is a `Build`, which describes the location
// of the source to build, how to build the source, and where to store the
// built artifacts, if any.
//
// A user can list previously-requested builds or get builds by their ID to
// determine the status of the build.
service CloudBuild {
option (google.api.default_host) = "cloudbuild.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Starts a build with the specified configuration.
//
// This method returns a long-running `Operation`, which includes the build
// ID. Pass the build ID to `GetBuild` to determine the build status (such as
// `SUCCESS` or `FAILURE`).
rpc CreateBuild(CreateBuildRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/projects/{project_id}/builds"
body: "build"
additional_bindings {
post: "/v1/{parent=projects/*/locations/*}/builds"
body: "build"
}
};
option (google.api.routing) = {
routing_parameters {
field: "parent"
path_template: "projects/*/locations/{location=*}"
}
};
option (google.api.method_signature) = "project_id,build";
option (google.longrunning.operation_info) = {
response_type: "Build"
metadata_type: "BuildOperationMetadata"
};
}
// Returns information about a previously requested build.
//
// The `Build` that is returned includes its status (such as `SUCCESS`,
// `FAILURE`, or `WORKING`), and timing information.
rpc GetBuild(GetBuildRequest) returns (Build) {
option (google.api.http) = {
get: "/v1/projects/{project_id}/builds/{id}"
additional_bindings { get: "/v1/{name=projects/*/locations/*/builds/*}" }
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "projects/*/locations/{location=*}/builds/*"
}
};
option (google.api.method_signature) = "project_id,id";
}
// Lists previously requested builds.
//
// Previously requested builds may still be in-progress, or may have finished
// successfully or unsuccessfully.
rpc ListBuilds(ListBuildsRequest) returns (ListBuildsResponse) {
option (google.api.http) = {
get: "/v1/projects/{project_id}/builds"
additional_bindings { get: "/v1/{parent=projects/*/locations/*}/builds" }
};
option (google.api.routing) = {
routing_parameters {
field: "parent"
path_template: "projects/*/locations/{location=*}"
}
};
option (google.api.method_signature) = "project_id,filter";
}
// Cancels a build in progress.
rpc CancelBuild(CancelBuildRequest) returns (Build) {
option (google.api.http) = {
post: "/v1/projects/{project_id}/builds/{id}:cancel"
body: "*"
additional_bindings {
post: "/v1/{name=projects/*/locations/*/builds/*}:cancel"
body: "*"
}
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "projects/*/locations/{location=*}/builds/*"
}
};
option (google.api.method_signature) = "project_id,id";
}
// Creates a new build based on the specified build.
//
// This method creates a new build using the original build request, which may
// or may not result in an identical build.
//
// For triggered builds:
//
// * Triggered builds resolve to a precise revision; therefore a retry of a
// triggered build will result in a build that uses the same revision.
//
// For non-triggered builds that specify `RepoSource`:
//
// * If the original build built from the tip of a branch, the retried build
// will build from the tip of that branch, which may not be the same revision
// as the original build.
// * If the original build specified a commit sha or revision ID, the retried
// build will use the identical source.
//
// For builds that specify `StorageSource`:
//
// * If the original build pulled source from Cloud Storage without
// specifying the generation of the object, the new build will use the current
// object, which may be different from the original build source.
// * If the original build pulled source from Cloud Storage and specified the
// generation of the object, the new build will attempt to use the same
// object, which may or may not be available depending on the bucket's
// lifecycle management settings.
rpc RetryBuild(RetryBuildRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/projects/{project_id}/builds/{id}:retry"
body: "*"
additional_bindings {
post: "/v1/{name=projects/*/locations/*/builds/*}:retry"
body: "*"
}
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "projects/*/locations/{location=*}/builds/*"
}
};
option (google.api.method_signature) = "project_id,id";
option (google.longrunning.operation_info) = {
response_type: "Build"
metadata_type: "BuildOperationMetadata"
};
}
// Approves or rejects a pending build.
//
// If approved, the returned LRO will be analogous to the LRO returned from
// a CreateBuild call.
//
// If rejected, the returned LRO will be immediately done.
rpc ApproveBuild(ApproveBuildRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{name=projects/*/builds/*}:approve"
body: "*"
additional_bindings {
post: "/v1/{name=projects/*/locations/*/builds/*}:approve"
body: "*"
}
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "projects/*/locations/{location=*}/builds/*"
}
};
option (google.api.method_signature) = "name,approval_result";
option (google.longrunning.operation_info) = {
response_type: "Build"
metadata_type: "BuildOperationMetadata"
};
}
// Creates a new `BuildTrigger`.
//
// This API is experimental.
rpc CreateBuildTrigger(CreateBuildTriggerRequest) returns (BuildTrigger) {
option (google.api.http) = {
post: "/v1/projects/{project_id}/triggers"
body: "trigger"
additional_bindings {
post: "/v1/{parent=projects/*/locations/*}/triggers"
body: "trigger"
}
};
option (google.api.routing) = {
routing_parameters {
field: "parent"
path_template: "projects/*/locations/{location=*}"
}
};
option (google.api.method_signature) = "project_id,trigger";
}
// Returns information about a `BuildTrigger`.
//
// This API is experimental.
rpc GetBuildTrigger(GetBuildTriggerRequest) returns (BuildTrigger) {
option (google.api.http) = {
get: "/v1/projects/{project_id}/triggers/{trigger_id}"
additional_bindings {
get: "/v1/{name=projects/*/locations/*/triggers/*}"
}
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "projects/*/locations/{location=*}/triggers/*"
}
};
option (google.api.method_signature) = "project_id,trigger_id";
}
// Lists existing `BuildTrigger`s.
//
// This API is experimental.
rpc ListBuildTriggers(ListBuildTriggersRequest)
returns (ListBuildTriggersResponse) {
option (google.api.http) = {
get: "/v1/projects/{project_id}/triggers"
additional_bindings {
get: "/v1/{parent=projects/*/locations/*}/triggers"
}
};
option (google.api.routing) = {
routing_parameters {
field: "parent"
path_template: "projects/*/locations/{location=*}"
}
};
option (google.api.method_signature) = "project_id";
}
// Deletes a `BuildTrigger` by its project ID and trigger ID.
//
// This API is experimental.
rpc DeleteBuildTrigger(DeleteBuildTriggerRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/projects/{project_id}/triggers/{trigger_id}"
additional_bindings {
delete: "/v1/{name=projects/*/locations/*/triggers/*}"
}
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "projects/*/locations/{location=*}/triggers/*"
}
};
option (google.api.method_signature) = "project_id,trigger_id";
}
// Updates a `BuildTrigger` by its project ID and trigger ID.
//
// This API is experimental.
rpc UpdateBuildTrigger(UpdateBuildTriggerRequest) returns (BuildTrigger) {
option (google.api.http) = {
patch: "/v1/projects/{project_id}/triggers/{trigger_id}"
body: "trigger"
additional_bindings {
patch: "/v1/{trigger.resource_name=projects/*/locations/*/triggers/*}"
body: "trigger"
}
};
option (google.api.routing) = {
routing_parameters {
field: "trigger.resource_name"
path_template: "projects/*/locations/{location=*}/triggers/*"
}
};
option (google.api.method_signature) = "project_id,trigger_id,trigger";
}
// Runs a `BuildTrigger` at a particular source revision.
//
// To run a regional or global trigger, use the POST request
// that includes the location endpoint in the path (ex.
// v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The
// POST request that does not include the location endpoint in the path can
// only be used when running global triggers.
rpc RunBuildTrigger(RunBuildTriggerRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/projects/{project_id}/triggers/{trigger_id}:run"
body: "source"
additional_bindings {
post: "/v1/{name=projects/*/locations/*/triggers/*}:run"
body: "*"
}
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "projects/*/locations/{location=*}/triggers/*"
}
};
option (google.api.method_signature) = "project_id,trigger_id,source";
option (google.longrunning.operation_info) = {
response_type: "Build"
metadata_type: "BuildOperationMetadata"
};
}
// ReceiveTriggerWebhook [Experimental] is called when the API receives a
// webhook request targeted at a specific trigger.
rpc ReceiveTriggerWebhook(ReceiveTriggerWebhookRequest)
returns (ReceiveTriggerWebhookResponse) {
option (google.api.http) = {
post: "/v1/projects/{project_id}/triggers/{trigger}:webhook"
body: "body"
additional_bindings {
post: "/v1/{name=projects/*/locations/*/triggers/*}:webhook"
body: "body"
}
};
}
// Creates a `WorkerPool`.
rpc CreateWorkerPool(CreateWorkerPoolRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/workerPools"
body: "worker_pool"
};
option (google.api.routing) = {
routing_parameters {
field: "parent"
path_template: "projects/*/locations/{location=*}"
}
};
option (google.api.method_signature) = "parent,worker_pool,worker_pool_id";
option (google.longrunning.operation_info) = {
response_type: "WorkerPool"
metadata_type: "CreateWorkerPoolOperationMetadata"
};
}
// Returns details of a `WorkerPool`.
rpc GetWorkerPool(GetWorkerPoolRequest) returns (WorkerPool) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/workerPools/*}"
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "projects/*/locations/{location=*}/workerPools/*"
}
};
option (google.api.method_signature) = "name";
}
// Deletes a `WorkerPool`.
rpc DeleteWorkerPool(DeleteWorkerPoolRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/workerPools/*}"
};
option (google.api.routing) = {
routing_parameters {
field: "name"
path_template: "projects/*/locations/{location=*}/workerPools/*"
}
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteWorkerPoolOperationMetadata"
};
}
// Updates a `WorkerPool`.
rpc UpdateWorkerPool(UpdateWorkerPoolRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{worker_pool.name=projects/*/locations/*/workerPools/*}"
body: "worker_pool"
};
option (google.api.routing) = {
routing_parameters {
field: "worker_pool.name"
path_template: "projects/*/locations/{location=*}/workerPools/*"
}
};
option (google.api.method_signature) = "worker_pool,update_mask";
option (google.longrunning.operation_info) = {
response_type: "WorkerPool"
metadata_type: "UpdateWorkerPoolOperationMetadata"
};
}
// Lists `WorkerPool`s.
rpc ListWorkerPools(ListWorkerPoolsRequest)
returns (ListWorkerPoolsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/workerPools"
};
option (google.api.routing) = {
routing_parameters {
field: "parent"
path_template: "projects/*/locations/{location=*}"
}
};
option (google.api.method_signature) = "parent";
}
}
// Specifies a build to retry.
message RetryBuildRequest {
// The name of the `Build` to retry.
// Format: `projects/{project}/locations/{location}/builds/{build}`
string name = 3 [(google.api.resource_reference) = {
type: "cloudbuild.googleapis.com/Build"
}];
// Required. ID of the project.
string project_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. Build ID of the original build.
string id = 2 [(google.api.field_behavior) = REQUIRED];
}
// Specifies a build trigger to run and the source to use.
message RunBuildTriggerRequest {
// The name of the `Trigger` to run.
// Format: `projects/{project}/locations/{location}/triggers/{trigger}`
string name = 4 [(google.api.resource_reference) = {
type: "cloudbuild.googleapis.com/BuildTrigger"
}];
// Required. ID of the project.
string project_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. ID of the trigger.
string trigger_id = 2 [(google.api.field_behavior) = REQUIRED];
// Source to build against this trigger.
// Branch and tag names cannot consist of regular expressions.
RepoSource source = 3;
}
// Location of the source in an archive file in Cloud Storage.
message StorageSource {
// Cloud Storage bucket containing the source (see
// [Bucket Name
// Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
string bucket = 1;
// Cloud Storage object containing the source.
//
// This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`)
// containing source to build.
string object = 2;
// Cloud Storage generation for the object. If the generation is
// omitted, the latest generation will be used.
int64 generation = 3;
}
// Location of the source in any accessible Git repository.
message GitSource {
// Location of the Git repo to build.
//
// This will be used as a `git remote`, see
// https://git-scm.com/docs/git-remote.
string url = 1;
// 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.
string dir = 5;
// The revision to fetch from the Git repository such as a branch, a tag, a
// commit SHA, or any Git ref.
//
// Cloud Build uses `git fetch` to fetch the revision from the Git
// repository; therefore make sure that the string you provide for `revision`
// is parsable by the command. For information on string values accepted by
// `git fetch`, see
// https://git-scm.com/docs/gitrevisions#_specifying_revisions. For
// information on `git fetch`, see https://git-scm.com/docs/git-fetch.
string revision = 6;
}
// Location of the source in a Google Cloud Source Repository.
message RepoSource {
// ID of the project that owns the Cloud Source Repository. If omitted, the
// project ID requesting the build is assumed.
string project_id = 1;
// Name of the Cloud Source Repository.
string repo_name = 2;
// A revision within the Cloud Source Repository must be specified in
// one of these ways.
oneof revision {
// 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
string branch_name = 3;
// 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
string tag_name = 4;
// Explicit commit SHA to build.
string commit_sha = 5;
}
// 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.
string dir = 7;
// Only trigger a build if the revision regex does NOT match the revision
// regex.
bool invert_regex = 8;
// Substitutions to use in a triggered build.
// Should only be used with RunBuildTrigger
map<string, string> substitutions = 9;
}
// Location of the source manifest in Cloud Storage.
// This feature is in Preview; see description
// [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).
message StorageSourceManifest {
// Cloud Storage bucket containing the source manifest (see [Bucket
// Name
// Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
string bucket = 1;
// Cloud Storage object containing the source manifest.
//
// This object must be a JSON file.
string object = 2;
// Cloud Storage generation for the object. If the generation is
// omitted, the latest generation will be used.
int64 generation = 3;
}
// Location of the source in a supported storage service.
message Source {
// Location of source.
oneof source {
// If provided, get the source from this location in Cloud Storage.
StorageSource storage_source = 2;
// If provided, get the source from this location in a Cloud Source
// Repository.
RepoSource repo_source = 3;
// If provided, get the source from this Git repository.
GitSource git_source = 5;
// If provided, get the source from this manifest in Cloud Storage.
// This feature is in Preview; see description
// [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).
StorageSourceManifest storage_source_manifest = 8;
}
}
// An image built by the pipeline.
message BuiltImage {
// Name used to push the container image to Google Container Registry, as
// presented to `docker push`.
string name = 1;
// Docker Registry 2.0 digest.
string digest = 3;
// Output only. Stores timing information for pushing the specified image.
TimeSpan push_timing = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Artifact uploaded using the PythonPackage directive.
message UploadedPythonPackage {
// URI of the uploaded artifact.
string uri = 1;
// Hash types and values of the Python Artifact.
FileHashes file_hashes = 2;
// Output only. Stores timing information for pushing the specified artifact.
TimeSpan push_timing = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A Maven artifact uploaded using the MavenArtifact directive.
message UploadedMavenArtifact {
// URI of the uploaded artifact.
string uri = 1;
// Hash types and values of the Maven Artifact.
FileHashes file_hashes = 2;
// Output only. Stores timing information for pushing the specified artifact.
TimeSpan push_timing = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// An npm package uploaded to Artifact Registry using the NpmPackage
// directive.
message UploadedNpmPackage {
// URI of the uploaded npm package.
string uri = 1;
// Hash types and values of the npm package.
FileHashes file_hashes = 2;
// Output only. Stores timing information for pushing the specified artifact.
TimeSpan push_timing = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A step in the build pipeline.
message BuildStep {
// 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.
string name = 1;
// 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".
repeated string env = 2;
// 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.
repeated string args = 3;
// 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.
string dir = 4;
// Unique identifier for this build step, used in `wait_for` to
// reference this build step as a dependency.
string id = 5;
// 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.
repeated string wait_for = 6;
// Entrypoint to be used instead of the build step image's default entrypoint.
// If unset, the image's default entrypoint is used.
string entrypoint = 7;
// 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`.
repeated string secret_env = 8;
// 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.
repeated Volume volumes = 9;
// Output only. Stores timing information for executing this build step.
TimeSpan timing = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Stores timing information for pulling this build step's
// builder image only.
TimeSpan pull_timing = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// 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.
google.protobuf.Duration timeout = 11;
// 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.
Build.Status status = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Allow this build step to fail without failing the entire build.
//
// If false, the entire build will fail if this step fails. Otherwise, the
// build will succeed, but this step will still have a failure status.
// Error information will be reported in the failure_detail field.
bool allow_failure = 14;
// Output only. Return code from running the step.
int32 exit_code = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
// Allow this build step to fail without failing the entire build if and
// only if the exit code is one of the specified codes. If allow_failure
// is also specified, this field will take precedence.
repeated int32 allow_exit_codes = 18;
// A shell script to be executed in the step.
//
// When script is provided, the user cannot specify the entrypoint or args.
string script = 19;
// Option to include built-in and custom substitutions as env variables
// for this build step. This option will override the global option
// in BuildOption.
optional bool automap_substitutions = 20;
}
// Volume describes a Docker container volume which is mounted into build steps
// in order to persist files across build step execution.
message 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.
string name = 1;
// 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.
string path = 2;
}
// Artifacts created by the build pipeline.
message Results {
// Container images that were built as a part of the build.
repeated BuiltImage images = 2;
// List of build step digests, in the order corresponding to build step
// indices.
repeated string build_step_images = 3;
// Path to the artifact manifest for non-container artifacts uploaded to Cloud
// Storage. Only populated when artifacts are uploaded to Cloud Storage.
string artifact_manifest = 4;
// Number of non-container artifacts uploaded to Cloud Storage. Only populated
// when artifacts are uploaded to Cloud Storage.
int64 num_artifacts = 5;
// 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.
repeated bytes build_step_outputs = 6;
// Time to push all non-container artifacts to Cloud Storage.
TimeSpan artifact_timing = 7;
// Python artifacts uploaded to Artifact Registry at the end of the build.
repeated UploadedPythonPackage python_packages = 8;
// Maven artifacts uploaded to Artifact Registry at the end of the build.
repeated UploadedMavenArtifact maven_artifacts = 9;
// Npm packages uploaded to Artifact Registry at the end of the build.
repeated UploadedNpmPackage npm_packages = 12;
}
// An artifact that was uploaded during a build. This
// is a single record in the artifact manifest JSON file.
message ArtifactResult {
// The path of an artifact in a Cloud Storage bucket, with the
// generation number. For example,
// `gs://mybucket/path/to/output.jar#generation`.
string location = 1;
// The file hash of the artifact.
repeated FileHashes file_hash = 2;
}
// 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.
// - $LOCATION: the location/region 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.
message Build {
option (google.api.resource) = {
type: "cloudbuild.googleapis.com/Build"
pattern: "projects/{project}/builds/{build}"
pattern: "projects/{project}/locations/{location}/builds/{build}"
};
// Possible status of a build or build step.
enum Status {
// Status of the build is unknown.
STATUS_UNKNOWN = 0;
// Build has been created and is pending execution and queuing. It has not
// been queued.
PENDING = 10;
// Build or step is queued; work has not yet begun.
QUEUED = 1;
// Build or step is being executed.
WORKING = 2;
// Build or step finished successfully.
SUCCESS = 3;
// Build or step failed to complete successfully.
FAILURE = 4;
// Build or step failed due to an internal cause.
INTERNAL_ERROR = 5;
// Build or step took longer than was allowed.
TIMEOUT = 6;
// Build or step was canceled by a user.
CANCELLED = 7;
// Build was enqueued for longer than the value of `queue_ttl`.
EXPIRED = 9;
}
// A non-fatal problem encountered during the execution of the build.
message Warning {
// The relative importance of this warning.
enum Priority {
// Should not be used.
PRIORITY_UNSPECIFIED = 0;
// e.g. deprecation warnings and alternative feature highlights.
INFO = 1;
// e.g. automated detection of possible issues with the build.
WARNING = 2;
// e.g. alerts that a feature used in the build is pending removal
ALERT = 3;
}
// Explanation of the warning generated.
string text = 1;
// The priority for this warning.
Priority priority = 2;
}
// A fatal problem encountered during the execution of the build.
message FailureInfo {
// The name of a fatal problem encountered during the execution of the
// build.
enum FailureType {
// Type unspecified
FAILURE_TYPE_UNSPECIFIED = 0;
// Unable to push the image to the repository.
PUSH_FAILED = 1;
// Final image not found.
PUSH_IMAGE_NOT_FOUND = 2;
// Unauthorized push of the final image.
PUSH_NOT_AUTHORIZED = 3;
// Backend logging failures. Should retry.
LOGGING_FAILURE = 4;
// A build step has failed.
USER_BUILD_STEP = 5;
// The source fetching has failed.
FETCH_SOURCE_FAILED = 6;
}
// The name of the failure.
FailureType type = 1;
// Explains the failure issue in more detail using hard-coded text.
string detail = 2;
}
// Output only. The 'Build' name with format:
// `projects/{project}/locations/{location}/builds/{build}`, where {build}
// is a unique identifier generated by the service.
string name = 45 [(google.api.field_behavior) = OUTPUT_ONLY];