google-cloud-build-v1 0.9.2 → 0.11.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -143,6 +143,27 @@ module Google
143
143
  #
144
144
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
145
  #
146
+ # @example Basic example
147
+ # require "google/longrunning"
148
+ #
149
+ # # Create a client object. The client can be reused for multiple calls.
150
+ # client = Google::Longrunning::Operations::Client.new
151
+ #
152
+ # # Create a request. To set request fields, pass in keyword arguments.
153
+ # request = Google::Longrunning::ListOperationsRequest.new
154
+ #
155
+ # # Call the list_operations method.
156
+ # result = client.list_operations request
157
+ #
158
+ # # The returned object is of type Gapic::PagedEnumerable. You can
159
+ # # iterate over all elements by calling #each, and the enumerable
160
+ # # will lazily make API calls to fetch subsequent pages. Other
161
+ # # methods are also available for managing paging directly.
162
+ # result.each do |response|
163
+ # # Each element is of type ::Google::Longrunning::Operation.
164
+ # p response
165
+ # end
166
+ #
146
167
  def list_operations request, options = nil
147
168
  raise ::ArgumentError, "request must be provided" if request.nil?
148
169
 
@@ -160,9 +181,11 @@ module Google
160
181
  gapic_version: ::Google::Cloud::Build::V1::VERSION
161
182
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
162
183
 
163
- header_params = {
164
- "name" => request.name
165
- }
184
+ header_params = {}
185
+ if request.name
186
+ header_params["name"] = request.name
187
+ end
188
+
166
189
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
167
190
  metadata[:"x-goog-request-params"] ||= request_params_header
168
191
 
@@ -215,6 +238,28 @@ module Google
215
238
  #
216
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
217
240
  #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use this
254
+ # # object to check the status of an operation, cancel it, or wait
255
+ # # for results. Here is how to block until completion:
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "Error!"
261
+ # end
262
+ #
218
263
  def get_operation request, options = nil
219
264
  raise ::ArgumentError, "request must be provided" if request.nil?
220
265
 
@@ -232,9 +277,11 @@ module Google
232
277
  gapic_version: ::Google::Cloud::Build::V1::VERSION
233
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
234
279
 
235
- header_params = {
236
- "name" => request.name
237
- }
280
+ header_params = {}
281
+ if request.name
282
+ header_params["name"] = request.name
283
+ end
284
+
238
285
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
239
286
  metadata[:"x-goog-request-params"] ||= request_params_header
240
287
 
@@ -287,6 +334,21 @@ module Google
287
334
  #
288
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
289
336
  #
337
+ # @example Basic example
338
+ # require "google/longrunning"
339
+ #
340
+ # # Create a client object. The client can be reused for multiple calls.
341
+ # client = Google::Longrunning::Operations::Client.new
342
+ #
343
+ # # Create a request. To set request fields, pass in keyword arguments.
344
+ # request = Google::Longrunning::DeleteOperationRequest.new
345
+ #
346
+ # # Call the delete_operation method.
347
+ # result = client.delete_operation request
348
+ #
349
+ # # The returned object is of type Google::Protobuf::Empty.
350
+ # p result
351
+ #
290
352
  def delete_operation request, options = nil
291
353
  raise ::ArgumentError, "request must be provided" if request.nil?
292
354
 
@@ -304,9 +366,11 @@ module Google
304
366
  gapic_version: ::Google::Cloud::Build::V1::VERSION
305
367
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
306
368
 
307
- header_params = {
308
- "name" => request.name
309
- }
369
+ header_params = {}
370
+ if request.name
371
+ header_params["name"] = request.name
372
+ end
373
+
310
374
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
311
375
  metadata[:"x-goog-request-params"] ||= request_params_header
312
376
 
@@ -364,6 +428,21 @@ module Google
364
428
  #
365
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
366
430
  #
431
+ # @example Basic example
432
+ # require "google/longrunning"
433
+ #
434
+ # # Create a client object. The client can be reused for multiple calls.
435
+ # client = Google::Longrunning::Operations::Client.new
436
+ #
437
+ # # Create a request. To set request fields, pass in keyword arguments.
438
+ # request = Google::Longrunning::CancelOperationRequest.new
439
+ #
440
+ # # Call the cancel_operation method.
441
+ # result = client.cancel_operation request
442
+ #
443
+ # # The returned object is of type Google::Protobuf::Empty.
444
+ # p result
445
+ #
367
446
  def cancel_operation request, options = nil
368
447
  raise ::ArgumentError, "request must be provided" if request.nil?
369
448
 
@@ -381,9 +460,11 @@ module Google
381
460
  gapic_version: ::Google::Cloud::Build::V1::VERSION
382
461
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
383
462
 
384
- header_params = {
385
- "name" => request.name
386
- }
463
+ header_params = {}
464
+ if request.name
465
+ header_params["name"] = request.name
466
+ end
467
+
387
468
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
388
469
  metadata[:"x-goog-request-params"] ||= request_params_header
389
470
 
@@ -444,6 +525,28 @@ module Google
444
525
  #
445
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
446
527
  #
528
+ # @example Basic example
529
+ # require "google/longrunning"
530
+ #
531
+ # # Create a client object. The client can be reused for multiple calls.
532
+ # client = Google::Longrunning::Operations::Client.new
533
+ #
534
+ # # Create a request. To set request fields, pass in keyword arguments.
535
+ # request = Google::Longrunning::WaitOperationRequest.new
536
+ #
537
+ # # Call the wait_operation method.
538
+ # result = client.wait_operation request
539
+ #
540
+ # # The returned object is of type Gapic::Operation. You can use this
541
+ # # object to check the status of an operation, cancel it, or wait
542
+ # # for results. Here is how to block until completion:
543
+ # result.wait_until_done! timeout: 60
544
+ # if result.response?
545
+ # p result.response
546
+ # else
547
+ # puts "Error!"
548
+ # end
549
+ #
447
550
  def wait_operation request, options = nil
448
551
  raise ::ArgumentError, "request must be provided" if request.nil?
449
552
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Build
23
23
  module V1
24
- VERSION = "0.9.2"
24
+ VERSION = "0.11.2"
25
25
  end
26
26
  end
27
27
  end
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/devtools/cloudbuild/v1/cloudbuild.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/api/field_behavior_pb'
@@ -13,6 +11,8 @@ require 'google/protobuf/duration_pb'
13
11
  require 'google/protobuf/empty_pb'
14
12
  require 'google/protobuf/field_mask_pb'
15
13
  require 'google/protobuf/timestamp_pb'
14
+ require 'google/protobuf'
15
+
16
16
  Google::Protobuf::DescriptorPool.generated_pool.build do
17
17
  add_file("google/devtools/cloudbuild/v1/cloudbuild.proto", :syntax => :proto3) do
18
18
  add_message "google.devtools.cloudbuild.v1.RetryBuildRequest" do
@@ -74,6 +74,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
74
74
  optional :pull_timing, :message, 13, "google.devtools.cloudbuild.v1.TimeSpan"
75
75
  optional :timeout, :message, 11, "google.protobuf.Duration"
76
76
  optional :status, :enum, 12, "google.devtools.cloudbuild.v1.Build.Status"
77
+ optional :script, :string, 19
77
78
  end
78
79
  add_message "google.devtools.cloudbuild.v1.Volume" do
79
80
  optional :name, :string, 1
@@ -116,6 +117,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
116
117
  repeated :tags, :string, 31
117
118
  repeated :secrets, :message, 32, "google.devtools.cloudbuild.v1.Secret"
118
119
  map :timing, :string, :message, 33, "google.devtools.cloudbuild.v1.TimeSpan"
120
+ optional :approval, :message, 44, "google.devtools.cloudbuild.v1.BuildApproval"
119
121
  optional :service_account, :string, 42
120
122
  optional :available_secrets, :message, 47, "google.devtools.cloudbuild.v1.Secrets"
121
123
  repeated :warnings, :message, 49, "google.devtools.cloudbuild.v1.Build.Warning"
@@ -146,6 +148,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
146
148
  end
147
149
  add_enum "google.devtools.cloudbuild.v1.Build.Status" do
148
150
  value :STATUS_UNKNOWN, 0
151
+ value :PENDING, 10
149
152
  value :QUEUED, 1
150
153
  value :WORKING, 2
151
154
  value :SUCCESS, 3
@@ -231,6 +234,37 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
231
234
  optional :project_id, :string, 1
232
235
  optional :id, :string, 2
233
236
  end
237
+ add_message "google.devtools.cloudbuild.v1.ApproveBuildRequest" do
238
+ optional :name, :string, 1
239
+ optional :approval_result, :message, 2, "google.devtools.cloudbuild.v1.ApprovalResult"
240
+ end
241
+ add_message "google.devtools.cloudbuild.v1.BuildApproval" do
242
+ optional :state, :enum, 1, "google.devtools.cloudbuild.v1.BuildApproval.State"
243
+ optional :config, :message, 2, "google.devtools.cloudbuild.v1.ApprovalConfig"
244
+ optional :result, :message, 3, "google.devtools.cloudbuild.v1.ApprovalResult"
245
+ end
246
+ add_enum "google.devtools.cloudbuild.v1.BuildApproval.State" do
247
+ value :STATE_UNSPECIFIED, 0
248
+ value :PENDING, 1
249
+ value :APPROVED, 2
250
+ value :REJECTED, 3
251
+ value :CANCELLED, 5
252
+ end
253
+ add_message "google.devtools.cloudbuild.v1.ApprovalConfig" do
254
+ optional :approval_required, :bool, 1
255
+ end
256
+ add_message "google.devtools.cloudbuild.v1.ApprovalResult" do
257
+ optional :approver_account, :string, 2
258
+ optional :approval_time, :message, 3, "google.protobuf.Timestamp"
259
+ optional :decision, :enum, 4, "google.devtools.cloudbuild.v1.ApprovalResult.Decision"
260
+ optional :comment, :string, 5
261
+ optional :url, :string, 6
262
+ end
263
+ add_enum "google.devtools.cloudbuild.v1.ApprovalResult.Decision" do
264
+ value :DECISION_UNSPECIFIED, 0
265
+ value :APPROVED, 1
266
+ value :REJECTED, 2
267
+ end
234
268
  add_message "google.devtools.cloudbuild.v1.BuildTrigger" do
235
269
  optional :resource_name, :string, 34
236
270
  optional :id, :string, 1
@@ -247,6 +281,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
247
281
  repeated :ignored_files, :string, 15
248
282
  repeated :included_files, :string, 16
249
283
  optional :filter, :string, 30
284
+ optional :service_account, :string, 33
250
285
  oneof :build_template do
251
286
  optional :autodetect, :bool, 18
252
287
  optional :build, :message, 4, "google.devtools.cloudbuild.v1.Build"
@@ -513,6 +548,12 @@ module Google
513
548
  ListBuildsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.ListBuildsRequest").msgclass
514
549
  ListBuildsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.ListBuildsResponse").msgclass
515
550
  CancelBuildRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.CancelBuildRequest").msgclass
551
+ ApproveBuildRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.ApproveBuildRequest").msgclass
552
+ BuildApproval = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.BuildApproval").msgclass
553
+ BuildApproval::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.BuildApproval.State").enummodule
554
+ ApprovalConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.ApprovalConfig").msgclass
555
+ ApprovalResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.ApprovalResult").msgclass
556
+ ApprovalResult::Decision = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.ApprovalResult.Decision").enummodule
516
557
  BuildTrigger = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.BuildTrigger").msgclass
517
558
  GitHubEventsConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.GitHubEventsConfig").msgclass
518
559
  PubsubConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.cloudbuild.v1.PubsubConfig").msgclass
@@ -34,7 +34,7 @@ module Google
34
34
  # determine the status of the build.
35
35
  class Service
36
36
 
37
- include GRPC::GenericService
37
+ include ::GRPC::GenericService
38
38
 
39
39
  self.marshal_class_method = :encode
40
40
  self.unmarshal_class_method = :decode
@@ -86,6 +86,13 @@ module Google
86
86
  # object, which may or may not be available depending on the bucket's
87
87
  # lifecycle management settings.
88
88
  rpc :RetryBuild, ::Google::Cloud::Build::V1::RetryBuildRequest, ::Google::Longrunning::Operation
89
+ # Approves or rejects a pending build.
90
+ #
91
+ # If approved, the returned LRO will be analogous to the LRO returned from
92
+ # a CreateBuild call.
93
+ #
94
+ # If rejected, the returned LRO will be immediately done.
95
+ rpc :ApproveBuild, ::Google::Cloud::Build::V1::ApproveBuildRequest, ::Google::Longrunning::Operation
89
96
  # Creates a new `BuildTrigger`.
90
97
  #
91
98
  # This API is experimental.
@@ -39,12 +39,15 @@ module Google
39
39
  #
40
40
  # // The raw HTTP body is bound to this field.
41
41
  # google.api.HttpBody http_body = 2;
42
+ #
42
43
  # }
43
44
  #
44
45
  # service ResourceService {
45
- # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
46
- # rpc UpdateResource(google.api.HttpBody) returns
47
- # (google.protobuf.Empty);
46
+ # rpc GetResource(GetResourceRequest)
47
+ # returns (google.api.HttpBody);
48
+ # rpc UpdateResource(google.api.HttpBody)
49
+ # returns (google.protobuf.Empty);
50
+ #
48
51
  # }
49
52
  #
50
53
  # Example with streaming methods:
@@ -54,6 +57,7 @@ module Google
54
57
  # returns (stream google.api.HttpBody);
55
58
  # rpc UpdateCalendar(stream google.api.HttpBody)
56
59
  # returns (stream google.api.HttpBody);
60
+ #
57
61
  # }
58
62
  #
59
63
  # Use of this type only changes how the request and response bodies are
@@ -277,6 +277,11 @@ module Google
277
277
  # Output only. Status of the build step. At this time, build step status is
278
278
  # only updated on build completion; step status is not updated in real-time
279
279
  # as the build progresses.
280
+ # @!attribute [rw] script
281
+ # @return [::String]
282
+ # A shell script to be executed in the step.
283
+ #
284
+ # When script is provided, the user cannot specify the entrypoint or args.
280
285
  class BuildStep
281
286
  include ::Google::Protobuf::MessageExts
282
287
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -478,6 +483,10 @@ module Google
478
483
  #
479
484
  # If the build does not specify source or images,
480
485
  # these keys will not be included.
486
+ # @!attribute [r] approval
487
+ # @return [::Google::Cloud::Build::V1::BuildApproval]
488
+ # Output only. Describes this build's approval configuration, status,
489
+ # and result.
481
490
  # @!attribute [rw] service_account
482
491
  # @return [::String]
483
492
  # IAM service account whose credentials will be used at build runtime.
@@ -584,6 +593,10 @@ module Google
584
593
  # Status of the build is unknown.
585
594
  STATUS_UNKNOWN = 0
586
595
 
596
+ # Build has been created and is pending execution and queuing. It has not
597
+ # been queued.
598
+ PENDING = 10
599
+
587
600
  # Build or step is queued; work has not yet begun.
588
601
  QUEUED = 1
589
602
 
@@ -935,6 +948,103 @@ module Google
935
948
  extend ::Google::Protobuf::MessageExts::ClassMethods
936
949
  end
937
950
 
951
+ # Request to approve or reject a pending build.
952
+ # @!attribute [rw] name
953
+ # @return [::String]
954
+ # Required. Name of the target build.
955
+ # For example: "projects/\\{$project_id}/builds/\\{$build_id}"
956
+ # @!attribute [rw] approval_result
957
+ # @return [::Google::Cloud::Build::V1::ApprovalResult]
958
+ # Approval decision and metadata.
959
+ class ApproveBuildRequest
960
+ include ::Google::Protobuf::MessageExts
961
+ extend ::Google::Protobuf::MessageExts::ClassMethods
962
+ end
963
+
964
+ # BuildApproval describes a build's approval configuration, state, and
965
+ # result.
966
+ # @!attribute [r] state
967
+ # @return [::Google::Cloud::Build::V1::BuildApproval::State]
968
+ # Output only. The state of this build's approval.
969
+ # @!attribute [r] config
970
+ # @return [::Google::Cloud::Build::V1::ApprovalConfig]
971
+ # Output only. Configuration for manual approval of this build.
972
+ # @!attribute [r] result
973
+ # @return [::Google::Cloud::Build::V1::ApprovalResult]
974
+ # Output only. Result of manual approval for this Build.
975
+ class BuildApproval
976
+ include ::Google::Protobuf::MessageExts
977
+ extend ::Google::Protobuf::MessageExts::ClassMethods
978
+
979
+ # Specifies the current state of a build's approval.
980
+ module State
981
+ # Default enum type. This should not be used.
982
+ STATE_UNSPECIFIED = 0
983
+
984
+ # Build approval is pending.
985
+ PENDING = 1
986
+
987
+ # Build approval has been approved.
988
+ APPROVED = 2
989
+
990
+ # Build approval has been rejected.
991
+ REJECTED = 3
992
+
993
+ # Build was cancelled while it was still pending approval.
994
+ CANCELLED = 5
995
+ end
996
+ end
997
+
998
+ # ApprovalConfig describes configuration for manual approval of a build.
999
+ # @!attribute [rw] approval_required
1000
+ # @return [::Boolean]
1001
+ # Whether or not approval is needed. If this is set on a build, it will
1002
+ # become pending when created, and will need to be explicitly approved
1003
+ # to start.
1004
+ class ApprovalConfig
1005
+ include ::Google::Protobuf::MessageExts
1006
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1007
+ end
1008
+
1009
+ # ApprovalResult describes the decision and associated metadata of a manual
1010
+ # approval of a build.
1011
+ # @!attribute [r] approver_account
1012
+ # @return [::String]
1013
+ # Output only. Email of the user that called the ApproveBuild API to
1014
+ # approve or reject a build at the time that the API was called.
1015
+ # @!attribute [r] approval_time
1016
+ # @return [::Google::Protobuf::Timestamp]
1017
+ # Output only. The time when the approval decision was made.
1018
+ # @!attribute [rw] decision
1019
+ # @return [::Google::Cloud::Build::V1::ApprovalResult::Decision]
1020
+ # Required. The decision of this manual approval.
1021
+ # @!attribute [rw] comment
1022
+ # @return [::String]
1023
+ # Optional. An optional comment for this manual approval result.
1024
+ # @!attribute [rw] url
1025
+ # @return [::String]
1026
+ # Optional. An optional URL tied to this manual approval result. This field
1027
+ # is essentially the same as comment, except that it will be rendered by the
1028
+ # UI differently. An example use case is a link to an external job that
1029
+ # approved this Build.
1030
+ class ApprovalResult
1031
+ include ::Google::Protobuf::MessageExts
1032
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1033
+
1034
+ # Specifies whether or not this manual approval result is to approve
1035
+ # or reject a build.
1036
+ module Decision
1037
+ # Default enum type. This should not be used.
1038
+ DECISION_UNSPECIFIED = 0
1039
+
1040
+ # Build is approved.
1041
+ APPROVED = 1
1042
+
1043
+ # Build is rejected.
1044
+ REJECTED = 2
1045
+ end
1046
+ end
1047
+
938
1048
  # Configuration for an automated build in response to source repository
939
1049
  # changes.
940
1050
  # @!attribute [rw] resource_name
@@ -1034,6 +1144,13 @@ module Google
1034
1144
  # @!attribute [rw] filter
1035
1145
  # @return [::String]
1036
1146
  # Optional. A Common Expression Language string.
1147
+ # @!attribute [rw] service_account
1148
+ # @return [::String]
1149
+ # The service account used for all user-controlled operations including
1150
+ # UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild.
1151
+ # If no service account is set, then the standard Cloud Build service account
1152
+ # ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead.
1153
+ # Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`
1037
1154
  class BuildTrigger
1038
1155
  include ::Google::Protobuf::MessageExts
1039
1156
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-build-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.2
4
+ version: 0.11.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-08-11 00:00:00.000000000 Z
11
+ date: 2021-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common