/
classes.rb
1725 lines (1448 loc) · 71.5 KB
/
classes.rb
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 2015 Google Inc.
#
# 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.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module CloudbuildV1
# Files in the workspace to upload to Cloud Storage upon successful completion
# of all build steps.
class ArtifactObjects
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# Path globs used to match files in the build's workspace.
# Corresponds to the JSON property `paths`
# @return [Array<String>]
attr_accessor :paths
# Start and end times for a build execution phase.
# Corresponds to the JSON property `timing`
# @return [Google::Apis::CloudbuildV1::TimeSpan]
attr_accessor :timing
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@location = args[:location] if args.key?(:location)
@paths = args[:paths] if args.key?(:paths)
@timing = args[:timing] if args.key?(:timing)
end
end
# An artifact that was uploaded during a build. This is a single record in the
# artifact manifest JSON file.
class ArtifactResult
include Google::Apis::Core::Hashable
# The file hash of the artifact.
# Corresponds to the JSON property `fileHash`
# @return [Array<Google::Apis::CloudbuildV1::FileHashes>]
attr_accessor :file_hash
# The path of an artifact in a Google Cloud Storage bucket, with the generation
# number. For example, `gs://mybucket/path/to/output.jar#generation`.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@file_hash = args[:file_hash] if args.key?(:file_hash)
@location = args[:location] if args.key?(:location)
end
end
# Artifacts produced by a build that should be uploaded upon successful
# completion of all build steps.
class Artifacts
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `images`
# @return [Array<String>]
attr_accessor :images
# Files in the workspace to upload to Cloud Storage upon successful completion
# of all build steps.
# Corresponds to the JSON property `objects`
# @return [Google::Apis::CloudbuildV1::ArtifactObjects]
attr_accessor :objects
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@images = args[:images] if args.key?(:images)
@objects = args[:objects] if args.key?(:objects)
end
end
# A build resource in the Cloud Build API. At a high level, a `Build` describes
# where to find source code, how to build it (for example, the builder image to
# run on the source), and where to store the built artifacts. Fields can include
# the following variables, which will be expanded when the build is created: - $
# PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of
# the build. - $REPO_NAME: the source repository name specified by RepoSource. -
# $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag
# name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA
# specified by RepoSource or resolved from the specified branch or tag. - $
# SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
class Build
include Google::Apis::Core::Hashable
# Artifacts produced by a build that should be uploaded upon successful
# completion of all build steps.
# Corresponds to the JSON property `artifacts`
# @return [Google::Apis::CloudbuildV1::Artifacts]
attr_accessor :artifacts
# Output only. The ID of the `BuildTrigger` that triggered this build, if it was
# triggered automatically.
# Corresponds to the JSON property `buildTriggerId`
# @return [String]
attr_accessor :build_trigger_id
# Output only. Time at which the request to create the build was received.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# 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.
# Corresponds to the JSON property `finishTime`
# @return [String]
attr_accessor :finish_time
# Output only. Unique identifier of the build.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# 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`.
# Corresponds to the JSON property `images`
# @return [Array<String>]
attr_accessor :images
# Output only. URL to logs for this build in Google Cloud Console.
# Corresponds to the JSON property `logUrl`
# @return [String]
attr_accessor :log_url
# 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`.
# Corresponds to the JSON property `logsBucket`
# @return [String]
attr_accessor :logs_bucket
# Output only. The 'Build' name with format: `projects/`project`/locations/`
# location`/builds/`build``, where `build` is a unique identifier generated by
# the service.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Optional arguments to enable specific features of builds.
# Corresponds to the JSON property `options`
# @return [Google::Apis::CloudbuildV1::BuildOptions]
attr_accessor :options
# Output only. ID of the project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# 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.
# Corresponds to the JSON property `queueTtl`
# @return [String]
attr_accessor :queue_ttl
# Artifacts created by the build pipeline.
# Corresponds to the JSON property `results`
# @return [Google::Apis::CloudbuildV1::Results]
attr_accessor :results
# Secrets to decrypt using Cloud Key Management Service.
# Corresponds to the JSON property `secrets`
# @return [Array<Google::Apis::CloudbuildV1::Secret>]
attr_accessor :secrets
# IAM service account whose credentials will be used at build runtime. Must be
# of the format `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. ACCOUNT can
# be email address or uniqueId of the service account. This field is in alpha
# and is not publicly available.
# Corresponds to the JSON property `serviceAccount`
# @return [String]
attr_accessor :service_account
# Location of the source in a supported storage service.
# Corresponds to the JSON property `source`
# @return [Google::Apis::CloudbuildV1::Source]
attr_accessor :source
# Provenance of the source. Ways to find the original source, or verify that
# some source was used for this build.
# Corresponds to the JSON property `sourceProvenance`
# @return [Google::Apis::CloudbuildV1::SourceProvenance]
attr_accessor :source_provenance
# Output only. Time at which execution of the build was started.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# Output only. Status of the build.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# Output only. Customer-readable message about the current status.
# Corresponds to the JSON property `statusDetail`
# @return [String]
attr_accessor :status_detail
# Required. The operations to be performed on the workspace.
# Corresponds to the JSON property `steps`
# @return [Array<Google::Apis::CloudbuildV1::BuildStep>]
attr_accessor :steps
# Substitutions data for `Build` resource.
# Corresponds to the JSON property `substitutions`
# @return [Hash<String,String>]
attr_accessor :substitutions
# Tags for annotation of a `Build`. These are not docker tags.
# Corresponds to the JSON property `tags`
# @return [Array<String>]
attr_accessor :tags
# 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.
# Corresponds to the JSON property `timeout`
# @return [String]
attr_accessor :timeout
# 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.
# Corresponds to the JSON property `timing`
# @return [Hash<String,Google::Apis::CloudbuildV1::TimeSpan>]
attr_accessor :timing
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@artifacts = args[:artifacts] if args.key?(:artifacts)
@build_trigger_id = args[:build_trigger_id] if args.key?(:build_trigger_id)
@create_time = args[:create_time] if args.key?(:create_time)
@finish_time = args[:finish_time] if args.key?(:finish_time)
@id = args[:id] if args.key?(:id)
@images = args[:images] if args.key?(:images)
@log_url = args[:log_url] if args.key?(:log_url)
@logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket)
@name = args[:name] if args.key?(:name)
@options = args[:options] if args.key?(:options)
@project_id = args[:project_id] if args.key?(:project_id)
@queue_ttl = args[:queue_ttl] if args.key?(:queue_ttl)
@results = args[:results] if args.key?(:results)
@secrets = args[:secrets] if args.key?(:secrets)
@service_account = args[:service_account] if args.key?(:service_account)
@source = args[:source] if args.key?(:source)
@source_provenance = args[:source_provenance] if args.key?(:source_provenance)
@start_time = args[:start_time] if args.key?(:start_time)
@status = args[:status] if args.key?(:status)
@status_detail = args[:status_detail] if args.key?(:status_detail)
@steps = args[:steps] if args.key?(:steps)
@substitutions = args[:substitutions] if args.key?(:substitutions)
@tags = args[:tags] if args.key?(:tags)
@timeout = args[:timeout] if args.key?(:timeout)
@timing = args[:timing] if args.key?(:timing)
end
end
# Metadata for build operations.
class BuildOperationMetadata
include Google::Apis::Core::Hashable
# A build resource in the Cloud Build API. At a high level, a `Build` describes
# where to find source code, how to build it (for example, the builder image to
# run on the source), and where to store the built artifacts. Fields can include
# the following variables, which will be expanded when the build is created: - $
# PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of
# the build. - $REPO_NAME: the source repository name specified by RepoSource. -
# $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag
# name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA
# specified by RepoSource or resolved from the specified branch or tag. - $
# SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
# Corresponds to the JSON property `build`
# @return [Google::Apis::CloudbuildV1::Build]
attr_accessor :build
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@build = args[:build] if args.key?(:build)
end
end
# Optional arguments to enable specific features of builds.
class BuildOptions
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# 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.
# Corresponds to the JSON property `dynamicSubstitutions`
# @return [Boolean]
attr_accessor :dynamic_substitutions
alias_method :dynamic_substitutions?, :dynamic_substitutions
# 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".
# Corresponds to the JSON property `env`
# @return [Array<String>]
attr_accessor :env
# Option to define build log streaming behavior to Google Cloud Storage.
# Corresponds to the JSON property `logStreamingOption`
# @return [String]
attr_accessor :log_streaming_option
# Option to specify the logging mode, which determines if and where build logs
# are stored.
# Corresponds to the JSON property `logging`
# @return [String]
attr_accessor :logging
# Compute Engine machine type on which to run the build.
# Corresponds to the JSON property `machineType`
# @return [String]
attr_accessor :machine_type
# Requested verifiability options.
# Corresponds to the JSON property `requestedVerifyOption`
# @return [String]
attr_accessor :requested_verify_option
# 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.
# Corresponds to the JSON property `secretEnv`
# @return [Array<String>]
attr_accessor :secret_env
# Requested hash for SourceProvenance.
# Corresponds to the JSON property `sourceProvenanceHash`
# @return [Array<String>]
attr_accessor :source_provenance_hash
# 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.
# Corresponds to the JSON property `substitutionOption`
# @return [String]
attr_accessor :substitution_option
# 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.
# Corresponds to the JSON property `volumes`
# @return [Array<Google::Apis::CloudbuildV1::Volume>]
attr_accessor :volumes
# Option to specify a `WorkerPool` for the build. Format: projects/`project`/
# locations/`location`/workerPools/`workerPool` This field is experimental.
# Corresponds to the JSON property `workerPool`
# @return [String]
attr_accessor :worker_pool
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
@dynamic_substitutions = args[:dynamic_substitutions] if args.key?(:dynamic_substitutions)
@env = args[:env] if args.key?(:env)
@log_streaming_option = args[:log_streaming_option] if args.key?(:log_streaming_option)
@logging = args[:logging] if args.key?(:logging)
@machine_type = args[:machine_type] if args.key?(:machine_type)
@requested_verify_option = args[:requested_verify_option] if args.key?(:requested_verify_option)
@secret_env = args[:secret_env] if args.key?(:secret_env)
@source_provenance_hash = args[:source_provenance_hash] if args.key?(:source_provenance_hash)
@substitution_option = args[:substitution_option] if args.key?(:substitution_option)
@volumes = args[:volumes] if args.key?(:volumes)
@worker_pool = args[:worker_pool] if args.key?(:worker_pool)
end
end
# A step in the build pipeline.
class BuildStep
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `args`
# @return [Array<String>]
attr_accessor :args
# 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.
# Corresponds to the JSON property `dir`
# @return [String]
attr_accessor :dir
# Entrypoint to be used instead of the build step image's default entrypoint. If
# unset, the image's default entrypoint is used.
# Corresponds to the JSON property `entrypoint`
# @return [String]
attr_accessor :entrypoint
# 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".
# Corresponds to the JSON property `env`
# @return [Array<String>]
attr_accessor :env
# Unique identifier for this build step, used in `wait_for` to reference this
# build step as a dependency.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Start and end times for a build execution phase.
# Corresponds to the JSON property `pullTiming`
# @return [Google::Apis::CloudbuildV1::TimeSpan]
attr_accessor :pull_timing
# 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`.
# Corresponds to the JSON property `secretEnv`
# @return [Array<String>]
attr_accessor :secret_env
# 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.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# 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.
# Corresponds to the JSON property `timeout`
# @return [String]
attr_accessor :timeout
# Start and end times for a build execution phase.
# Corresponds to the JSON property `timing`
# @return [Google::Apis::CloudbuildV1::TimeSpan]
attr_accessor :timing
# 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.
# Corresponds to the JSON property `volumes`
# @return [Array<Google::Apis::CloudbuildV1::Volume>]
attr_accessor :volumes
# 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.
# Corresponds to the JSON property `waitFor`
# @return [Array<String>]
attr_accessor :wait_for
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@args = args[:args] if args.key?(:args)
@dir = args[:dir] if args.key?(:dir)
@entrypoint = args[:entrypoint] if args.key?(:entrypoint)
@env = args[:env] if args.key?(:env)
@id = args[:id] if args.key?(:id)
@name = args[:name] if args.key?(:name)
@pull_timing = args[:pull_timing] if args.key?(:pull_timing)
@secret_env = args[:secret_env] if args.key?(:secret_env)
@status = args[:status] if args.key?(:status)
@timeout = args[:timeout] if args.key?(:timeout)
@timing = args[:timing] if args.key?(:timing)
@volumes = args[:volumes] if args.key?(:volumes)
@wait_for = args[:wait_for] if args.key?(:wait_for)
end
end
# Configuration for an automated build in response to source repository changes.
class BuildTrigger
include Google::Apis::Core::Hashable
# A build resource in the Cloud Build API. At a high level, a `Build` describes
# where to find source code, how to build it (for example, the builder image to
# run on the source), and where to store the built artifacts. Fields can include
# the following variables, which will be expanded when the build is created: - $
# PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of
# the build. - $REPO_NAME: the source repository name specified by RepoSource. -
# $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag
# name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA
# specified by RepoSource or resolved from the specified branch or tag. - $
# SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
# Corresponds to the JSON property `build`
# @return [Google::Apis::CloudbuildV1::Build]
attr_accessor :build
# Output only. Time when the trigger was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Human-readable description of this trigger.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# If true, the trigger will never automatically execute a build.
# Corresponds to the JSON property `disabled`
# @return [Boolean]
attr_accessor :disabled
alias_method :disabled?, :disabled
# Path, from the source root, to a file whose contents is used for the template.
# Corresponds to the JSON property `filename`
# @return [String]
attr_accessor :filename
# GitHubEventsConfig describes the configuration of a trigger that creates a
# build whenever a GitHub event is received. This message is experimental.
# Corresponds to the JSON property `github`
# @return [Google::Apis::CloudbuildV1::GitHubEventsConfig]
attr_accessor :github
# Output only. Unique identifier of the trigger.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# ignored_files and included_files are file glob matches using https://golang.
# org/pkg/path/filepath/#Match extended with support for "**". If ignored_files
# and changed files are both empty, then they are not used to determine whether
# or not to trigger a build. If ignored_files is not empty, then we ignore any
# files that match any of the ignored_file globs. If the change has no files
# that are outside of the ignored_files globs, then we do not trigger a build.
# Corresponds to the JSON property `ignoredFiles`
# @return [Array<String>]
attr_accessor :ignored_files
# If any of the files altered in the commit pass the ignored_files filter and
# included_files is empty, then as far as this filter is concerned, we should
# trigger the build. If any of the files altered in the commit pass the
# ignored_files filter and included_files is not empty, then we make sure that
# at least one of those files matches a included_files glob. If not, then we do
# not trigger a build.
# Corresponds to the JSON property `includedFiles`
# @return [Array<String>]
attr_accessor :included_files
# User-assigned name of the trigger. Must be unique within the project. Trigger
# names must meet the following requirements: + They must contain only
# alphanumeric characters and dashes. + They can be 1-64 characters long. + They
# must begin and end with an alphanumeric character.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Substitutions for Build resource. The keys must match the following regular
# expression: `^_[A-Z0-9_]+$`.
# Corresponds to the JSON property `substitutions`
# @return [Hash<String,String>]
attr_accessor :substitutions
# Tags for annotation of a `BuildTrigger`
# Corresponds to the JSON property `tags`
# @return [Array<String>]
attr_accessor :tags
# Location of the source in a Google Cloud Source Repository.
# Corresponds to the JSON property `triggerTemplate`
# @return [Google::Apis::CloudbuildV1::RepoSource]
attr_accessor :trigger_template
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@build = args[:build] if args.key?(:build)
@create_time = args[:create_time] if args.key?(:create_time)
@description = args[:description] if args.key?(:description)
@disabled = args[:disabled] if args.key?(:disabled)
@filename = args[:filename] if args.key?(:filename)
@github = args[:github] if args.key?(:github)
@id = args[:id] if args.key?(:id)
@ignored_files = args[:ignored_files] if args.key?(:ignored_files)
@included_files = args[:included_files] if args.key?(:included_files)
@name = args[:name] if args.key?(:name)
@substitutions = args[:substitutions] if args.key?(:substitutions)
@tags = args[:tags] if args.key?(:tags)
@trigger_template = args[:trigger_template] if args.key?(:trigger_template)
end
end
# An image built by the pipeline.
class BuiltImage
include Google::Apis::Core::Hashable
# Docker Registry 2.0 digest.
# Corresponds to the JSON property `digest`
# @return [String]
attr_accessor :digest
# Name used to push the container image to Google Container Registry, as
# presented to `docker push`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Start and end times for a build execution phase.
# Corresponds to the JSON property `pushTiming`
# @return [Google::Apis::CloudbuildV1::TimeSpan]
attr_accessor :push_timing
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@digest = args[:digest] if args.key?(:digest)
@name = args[:name] if args.key?(:name)
@push_timing = args[:push_timing] if args.key?(:push_timing)
end
end
# Request to cancel an ongoing build.
class CancelBuildRequest
include Google::Apis::Core::Hashable
# Required. ID of the build.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# The name of the `Build` to cancel. Format: `projects/`project`/locations/`
# location`/builds/`build``
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Required. ID of the project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@name = args[:name] if args.key?(:name)
@project_id = args[:project_id] if args.key?(:project_id)
end
end
# The request message for Operations.CancelOperation.
class CancelOperationRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# 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 ````.
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Container message for hashes of byte content of files, used in
# SourceProvenance messages to verify integrity of source input to the build.
class FileHashes
include Google::Apis::Core::Hashable
# Collection of file hashes.
# Corresponds to the JSON property `fileHash`
# @return [Array<Google::Apis::CloudbuildV1::HashProp>]
attr_accessor :file_hash
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@file_hash = args[:file_hash] if args.key?(:file_hash)
end
end
# GitHubEventsConfig describes the configuration of a trigger that creates a
# build whenever a GitHub event is received. This message is experimental.
class GitHubEventsConfig
include Google::Apis::Core::Hashable
# The installationID that emits the GitHub event.
# Corresponds to the JSON property `installationId`
# @return [Fixnum]
attr_accessor :installation_id
# Name of the repository. For example: The name for https://github.com/
# googlecloudplatform/cloud-builders is "cloud-builders".
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Owner of the repository. For example: The owner for https://github.com/
# googlecloudplatform/cloud-builders is "googlecloudplatform".
# Corresponds to the JSON property `owner`
# @return [String]
attr_accessor :owner
# PullRequestFilter contains filter properties for matching GitHub Pull Requests.
# Corresponds to the JSON property `pullRequest`
# @return [Google::Apis::CloudbuildV1::PullRequestFilter]
attr_accessor :pull_request
# Push contains filter properties for matching GitHub git pushes.
# Corresponds to the JSON property `push`
# @return [Google::Apis::CloudbuildV1::PushFilter]
attr_accessor :push
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@installation_id = args[:installation_id] if args.key?(:installation_id)
@name = args[:name] if args.key?(:name)
@owner = args[:owner] if args.key?(:owner)
@pull_request = args[:pull_request] if args.key?(:pull_request)
@push = args[:push] if args.key?(:push)
end
end
# HTTPDelivery is the delivery configuration for an HTTP notification.
class HttpDelivery
include Google::Apis::Core::Hashable
# The URI to which JSON-containing HTTP POST requests should be sent.
# Corresponds to the JSON property `uri`
# @return [String]
attr_accessor :uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@uri = args[:uri] if args.key?(:uri)
end
end
# Container message for hash values.
class HashProp
include Google::Apis::Core::Hashable
# The type of hash that was performed.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# The hash value.
# Corresponds to the JSON property `value`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@value = args[:value] if args.key?(:value)
end
end
# Response containing existing `BuildTriggers`.
class ListBuildTriggersResponse
include Google::Apis::Core::Hashable
# Token to receive the next page of results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# `BuildTriggers` for the project, sorted by `create_time` descending.
# Corresponds to the JSON property `triggers`
# @return [Array<Google::Apis::CloudbuildV1::BuildTrigger>]
attr_accessor :triggers
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@triggers = args[:triggers] if args.key?(:triggers)
end
end
# Response including listed builds.
class ListBuildsResponse
include Google::Apis::Core::Hashable
# Builds will be sorted by `create_time`, descending.
# Corresponds to the JSON property `builds`
# @return [Array<Google::Apis::CloudbuildV1::Build>]
attr_accessor :builds
# Token to receive the next page of results. This will be absent if the end of
# the response list has been reached.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@builds = args[:builds] if args.key?(:builds)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Notification is the container which holds the data that is relevant to this
# particular notification.
class Notification
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `filter`
# @return [String]
attr_accessor :filter
# HTTPDelivery is the delivery configuration for an HTTP notification.
# Corresponds to the JSON property `httpDelivery`
# @return [Google::Apis::CloudbuildV1::HttpDelivery]
attr_accessor :http_delivery
# SlackDelivery is the delivery configuration for delivering Slack messages via
# webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/
# webhooks.
# Corresponds to the JSON property `slackDelivery`
# @return [Google::Apis::CloudbuildV1::SlackDelivery]
attr_accessor :slack_delivery
# SMTPDelivery is the delivery configuration for an SMTP (email) notification.
# Corresponds to the JSON property `smtpDelivery`
# @return [Google::Apis::CloudbuildV1::SmtpDelivery]
attr_accessor :smtp_delivery
# Escape hatch for users to supply custom delivery configs.
# Corresponds to the JSON property `structDelivery`
# @return [Hash<String,Object>]
attr_accessor :struct_delivery
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@filter = args[:filter] if args.key?(:filter)
@http_delivery = args[:http_delivery] if args.key?(:http_delivery)
@slack_delivery = args[:slack_delivery] if args.key?(:slack_delivery)
@smtp_delivery = args[:smtp_delivery] if args.key?(:smtp_delivery)
@struct_delivery = args[:struct_delivery] if args.key?(:struct_delivery)
end
end
# NotifierConfig is the top-level configuration message.
class NotifierConfig
include Google::Apis::Core::Hashable