google-cloud-workflows-v1beta 0.3.0 → 0.3.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +8 -8
- data/README.md +1 -1
- data/lib/google/cloud/workflows/v1beta/version.rb +1 -1
- data/lib/google/cloud/workflows/v1beta/workflows/client.rb +172 -57
- data/lib/google/cloud/workflows/v1beta/workflows/operations.rb +149 -37
- data/lib/google/cloud/workflows/v1beta/workflows_pb.rb +2 -2
- data/lib/google/cloud/workflows/v1beta/workflows_services_pb.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +7 -1
- metadata +13 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 242d104d35189a9cbbed81f92bd89f549b65a35c49433f96a0ddcb9227c843e5
|
4
|
+
data.tar.gz: 17aff3769c9330f7ba8cfe70a3b2ef0f8dab976aa0529c0ea4ef5c8bc199e806
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0e825486aec201ab9ea0f728f5c6caea3939d06fc8f0de92bdad1239d7b3c72b3c7181159f17e558fcb3191259f39ff5db4393395031cac69327b33f7bd9407a
|
7
|
+
data.tar.gz: ac588fddd3eaee477cd2fd19c8a4e067067e48ce4d89edb659633d1efb1e72c63768235b13b8bc445f506620c1209b228ec355214a2e95c603e16c04c7e33c89
|
data/AUTHENTICATION.md
CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-workflows-v1beta
|
|
66
66
|
checks for credentials are configured on the service Credentials class (such as
|
67
67
|
{::Google::Cloud::Workflows::V1beta::Workflows::Credentials}):
|
68
68
|
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
69
|
+
* `WORKFLOWS_CREDENTIALS` - Path to JSON file, or JSON contents
|
70
|
+
* `WORKFLOWS_KEYFILE` - Path to JSON file, or JSON contents
|
71
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
72
|
+
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
73
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
74
74
|
|
75
75
|
```ruby
|
76
76
|
require "google/cloud/workflows/v1beta"
|
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
|
82
82
|
|
83
83
|
### Configuration
|
84
84
|
|
85
|
-
The **Credentials JSON** can be configured instead of
|
86
|
-
environment
|
85
|
+
The path to the **Credentials JSON** file can be configured instead of storing
|
86
|
+
it in an environment variable. Either on an individual client initialization:
|
87
87
|
|
88
88
|
```ruby
|
89
89
|
require "google/cloud/workflows/v1beta"
|
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new do |config|
|
|
93
93
|
end
|
94
94
|
```
|
95
95
|
|
96
|
-
Or
|
96
|
+
Or globally for all clients:
|
97
97
|
|
98
98
|
```ruby
|
99
99
|
require "google/cloud/workflows/v1beta"
|
data/README.md
CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
33
33
|
require "google/cloud/workflows/v1beta"
|
34
34
|
|
35
35
|
client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
36
|
-
request =
|
36
|
+
request = ::Google::Cloud::Workflows::V1beta::ListWorkflowsRequest.new # (request fields as keyword arguments...)
|
37
37
|
response = client.list_workflows request
|
38
38
|
```
|
39
39
|
|
@@ -43,13 +43,12 @@ module Google
|
|
43
43
|
# See {::Google::Cloud::Workflows::V1beta::Workflows::Client::Configuration}
|
44
44
|
# for a description of the configuration fields.
|
45
45
|
#
|
46
|
-
#
|
46
|
+
# @example
|
47
47
|
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
# end
|
48
|
+
# # Modify the configuration for all Workflows clients
|
49
|
+
# ::Google::Cloud::Workflows::V1beta::Workflows::Client.configure do |config|
|
50
|
+
# config.timeout = 10.0
|
51
|
+
# end
|
53
52
|
#
|
54
53
|
# @yield [config] Configure the Client client.
|
55
54
|
# @yieldparam config [Client::Configuration]
|
@@ -96,19 +95,15 @@ module Google
|
|
96
95
|
##
|
97
96
|
# Create a new Workflows client object.
|
98
97
|
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
# To create a new Workflows client with the default
|
102
|
-
# configuration:
|
103
|
-
#
|
104
|
-
# client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
98
|
+
# @example
|
105
99
|
#
|
106
|
-
#
|
107
|
-
#
|
100
|
+
# # Create a client using the default configuration
|
101
|
+
# client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
108
102
|
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
103
|
+
# # Create a client using a custom configuration
|
104
|
+
# client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new do |config|
|
105
|
+
# config.timeout = 10.0
|
106
|
+
# end
|
112
107
|
#
|
113
108
|
# @yield [config] Configure the Workflows client.
|
114
109
|
# @yieldparam config [Client::Configuration]
|
@@ -128,14 +123,13 @@ module Google
|
|
128
123
|
|
129
124
|
# Create credentials
|
130
125
|
credentials = @config.credentials
|
131
|
-
# Use self-signed JWT if the
|
126
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
132
127
|
# but only if the default endpoint does not have a region prefix.
|
133
|
-
enable_self_signed_jwt = @config.
|
134
|
-
@config.endpoint == Client.configure.endpoint &&
|
128
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
135
129
|
!@config.endpoint.split(".").first.include?("-")
|
136
130
|
credentials ||= Credentials.default scope: @config.scope,
|
137
131
|
enable_self_signed_jwt: enable_self_signed_jwt
|
138
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
132
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
139
133
|
credentials = Credentials.new credentials, scope: @config.scope
|
140
134
|
end
|
141
135
|
@quota_project_id = @config.quota_project
|
@@ -213,6 +207,27 @@ module Google
|
|
213
207
|
#
|
214
208
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
215
209
|
#
|
210
|
+
# @example Basic example
|
211
|
+
# require "google/cloud/workflows/v1beta"
|
212
|
+
#
|
213
|
+
# # Create a client object. The client can be reused for multiple calls.
|
214
|
+
# client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
215
|
+
#
|
216
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
217
|
+
# request = Google::Cloud::Workflows::V1beta::ListWorkflowsRequest.new
|
218
|
+
#
|
219
|
+
# # Call the list_workflows method.
|
220
|
+
# result = client.list_workflows request
|
221
|
+
#
|
222
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
223
|
+
# # iterate over all elements by calling #each, and the enumerable
|
224
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
225
|
+
# # methods are also available for managing paging directly.
|
226
|
+
# result.each do |response|
|
227
|
+
# # Each element is of type ::Google::Cloud::Workflows::V1beta::Workflow.
|
228
|
+
# p response
|
229
|
+
# end
|
230
|
+
#
|
216
231
|
def list_workflows request, options = nil
|
217
232
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
218
233
|
|
@@ -230,16 +245,20 @@ module Google
|
|
230
245
|
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
231
246
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
232
247
|
|
233
|
-
header_params = {
|
234
|
-
|
235
|
-
|
248
|
+
header_params = {}
|
249
|
+
if request.parent
|
250
|
+
header_params["parent"] = request.parent
|
251
|
+
end
|
252
|
+
|
236
253
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
237
254
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
238
255
|
|
239
256
|
options.apply_defaults timeout: @config.rpcs.list_workflows.timeout,
|
240
257
|
metadata: metadata,
|
241
258
|
retry_policy: @config.rpcs.list_workflows.retry_policy
|
242
|
-
|
259
|
+
|
260
|
+
options.apply_defaults timeout: @config.timeout,
|
261
|
+
metadata: @config.metadata,
|
243
262
|
retry_policy: @config.retry_policy
|
244
263
|
|
245
264
|
@workflows_stub.call_rpc :list_workflows, request, options: options do |response, operation|
|
@@ -281,6 +300,21 @@ module Google
|
|
281
300
|
#
|
282
301
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
283
302
|
#
|
303
|
+
# @example Basic example
|
304
|
+
# require "google/cloud/workflows/v1beta"
|
305
|
+
#
|
306
|
+
# # Create a client object. The client can be reused for multiple calls.
|
307
|
+
# client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
308
|
+
#
|
309
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
310
|
+
# request = Google::Cloud::Workflows::V1beta::GetWorkflowRequest.new
|
311
|
+
#
|
312
|
+
# # Call the get_workflow method.
|
313
|
+
# result = client.get_workflow request
|
314
|
+
#
|
315
|
+
# # The returned object is of type Google::Cloud::Workflows::V1beta::Workflow.
|
316
|
+
# p result
|
317
|
+
#
|
284
318
|
def get_workflow request, options = nil
|
285
319
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
286
320
|
|
@@ -298,16 +332,20 @@ module Google
|
|
298
332
|
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
299
333
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
300
334
|
|
301
|
-
header_params = {
|
302
|
-
|
303
|
-
|
335
|
+
header_params = {}
|
336
|
+
if request.name
|
337
|
+
header_params["name"] = request.name
|
338
|
+
end
|
339
|
+
|
304
340
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
305
341
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
306
342
|
|
307
343
|
options.apply_defaults timeout: @config.rpcs.get_workflow.timeout,
|
308
344
|
metadata: metadata,
|
309
345
|
retry_policy: @config.rpcs.get_workflow.retry_policy
|
310
|
-
|
346
|
+
|
347
|
+
options.apply_defaults timeout: @config.timeout,
|
348
|
+
metadata: @config.metadata,
|
311
349
|
retry_policy: @config.retry_policy
|
312
350
|
|
313
351
|
@workflows_stub.call_rpc :get_workflow, request, options: options do |response, operation|
|
@@ -361,6 +399,28 @@ module Google
|
|
361
399
|
#
|
362
400
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
363
401
|
#
|
402
|
+
# @example Basic example
|
403
|
+
# require "google/cloud/workflows/v1beta"
|
404
|
+
#
|
405
|
+
# # Create a client object. The client can be reused for multiple calls.
|
406
|
+
# client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
407
|
+
#
|
408
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
409
|
+
# request = Google::Cloud::Workflows::V1beta::CreateWorkflowRequest.new
|
410
|
+
#
|
411
|
+
# # Call the create_workflow method.
|
412
|
+
# result = client.create_workflow request
|
413
|
+
#
|
414
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
415
|
+
# # object to check the status of an operation, cancel it, or wait
|
416
|
+
# # for results. Here is how to block until completion:
|
417
|
+
# result.wait_until_done! timeout: 60
|
418
|
+
# if result.response?
|
419
|
+
# p result.response
|
420
|
+
# else
|
421
|
+
# puts "Error!"
|
422
|
+
# end
|
423
|
+
#
|
364
424
|
def create_workflow request, options = nil
|
365
425
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
366
426
|
|
@@ -378,16 +438,20 @@ module Google
|
|
378
438
|
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
379
439
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
380
440
|
|
381
|
-
header_params = {
|
382
|
-
|
383
|
-
|
441
|
+
header_params = {}
|
442
|
+
if request.parent
|
443
|
+
header_params["parent"] = request.parent
|
444
|
+
end
|
445
|
+
|
384
446
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
385
447
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
386
448
|
|
387
449
|
options.apply_defaults timeout: @config.rpcs.create_workflow.timeout,
|
388
450
|
metadata: metadata,
|
389
451
|
retry_policy: @config.rpcs.create_workflow.retry_policy
|
390
|
-
|
452
|
+
|
453
|
+
options.apply_defaults timeout: @config.timeout,
|
454
|
+
metadata: @config.metadata,
|
391
455
|
retry_policy: @config.retry_policy
|
392
456
|
|
393
457
|
@workflows_stub.call_rpc :create_workflow, request, options: options do |response, operation|
|
@@ -431,6 +495,28 @@ module Google
|
|
431
495
|
#
|
432
496
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
433
497
|
#
|
498
|
+
# @example Basic example
|
499
|
+
# require "google/cloud/workflows/v1beta"
|
500
|
+
#
|
501
|
+
# # Create a client object. The client can be reused for multiple calls.
|
502
|
+
# client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
503
|
+
#
|
504
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
505
|
+
# request = Google::Cloud::Workflows::V1beta::DeleteWorkflowRequest.new
|
506
|
+
#
|
507
|
+
# # Call the delete_workflow method.
|
508
|
+
# result = client.delete_workflow request
|
509
|
+
#
|
510
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
511
|
+
# # object to check the status of an operation, cancel it, or wait
|
512
|
+
# # for results. Here is how to block until completion:
|
513
|
+
# result.wait_until_done! timeout: 60
|
514
|
+
# if result.response?
|
515
|
+
# p result.response
|
516
|
+
# else
|
517
|
+
# puts "Error!"
|
518
|
+
# end
|
519
|
+
#
|
434
520
|
def delete_workflow request, options = nil
|
435
521
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
436
522
|
|
@@ -448,16 +534,20 @@ module Google
|
|
448
534
|
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
449
535
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
450
536
|
|
451
|
-
header_params = {
|
452
|
-
|
453
|
-
|
537
|
+
header_params = {}
|
538
|
+
if request.name
|
539
|
+
header_params["name"] = request.name
|
540
|
+
end
|
541
|
+
|
454
542
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
455
543
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
456
544
|
|
457
545
|
options.apply_defaults timeout: @config.rpcs.delete_workflow.timeout,
|
458
546
|
metadata: metadata,
|
459
547
|
retry_policy: @config.rpcs.delete_workflow.retry_policy
|
460
|
-
|
548
|
+
|
549
|
+
options.apply_defaults timeout: @config.timeout,
|
550
|
+
metadata: @config.metadata,
|
461
551
|
retry_policy: @config.retry_policy
|
462
552
|
|
463
553
|
@workflows_stub.call_rpc :delete_workflow, request, options: options do |response, operation|
|
@@ -505,6 +595,28 @@ module Google
|
|
505
595
|
#
|
506
596
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
507
597
|
#
|
598
|
+
# @example Basic example
|
599
|
+
# require "google/cloud/workflows/v1beta"
|
600
|
+
#
|
601
|
+
# # Create a client object. The client can be reused for multiple calls.
|
602
|
+
# client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
603
|
+
#
|
604
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
605
|
+
# request = Google::Cloud::Workflows::V1beta::UpdateWorkflowRequest.new
|
606
|
+
#
|
607
|
+
# # Call the update_workflow method.
|
608
|
+
# result = client.update_workflow request
|
609
|
+
#
|
610
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
611
|
+
# # object to check the status of an operation, cancel it, or wait
|
612
|
+
# # for results. Here is how to block until completion:
|
613
|
+
# result.wait_until_done! timeout: 60
|
614
|
+
# if result.response?
|
615
|
+
# p result.response
|
616
|
+
# else
|
617
|
+
# puts "Error!"
|
618
|
+
# end
|
619
|
+
#
|
508
620
|
def update_workflow request, options = nil
|
509
621
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
510
622
|
|
@@ -522,16 +634,20 @@ module Google
|
|
522
634
|
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
523
635
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
524
636
|
|
525
|
-
header_params = {
|
526
|
-
|
527
|
-
|
637
|
+
header_params = {}
|
638
|
+
if request.workflow&.name
|
639
|
+
header_params["workflow.name"] = request.workflow.name
|
640
|
+
end
|
641
|
+
|
528
642
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
529
643
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
530
644
|
|
531
645
|
options.apply_defaults timeout: @config.rpcs.update_workflow.timeout,
|
532
646
|
metadata: metadata,
|
533
647
|
retry_policy: @config.rpcs.update_workflow.retry_policy
|
534
|
-
|
648
|
+
|
649
|
+
options.apply_defaults timeout: @config.timeout,
|
650
|
+
metadata: @config.metadata,
|
535
651
|
retry_policy: @config.retry_policy
|
536
652
|
|
537
653
|
@workflows_stub.call_rpc :update_workflow, request, options: options do |response, operation|
|
@@ -556,22 +672,21 @@ module Google
|
|
556
672
|
# Configuration can be applied globally to all clients, or to a single client
|
557
673
|
# on construction.
|
558
674
|
#
|
559
|
-
#
|
560
|
-
#
|
561
|
-
#
|
562
|
-
# to 20 seconds,
|
563
|
-
#
|
564
|
-
#
|
565
|
-
#
|
566
|
-
#
|
567
|
-
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
#
|
572
|
-
#
|
573
|
-
#
|
574
|
-
# end
|
675
|
+
# @example
|
676
|
+
#
|
677
|
+
# # Modify the global config, setting the timeout for
|
678
|
+
# # list_workflows to 20 seconds,
|
679
|
+
# # and all remaining timeouts to 10 seconds.
|
680
|
+
# ::Google::Cloud::Workflows::V1beta::Workflows::Client.configure do |config|
|
681
|
+
# config.timeout = 10.0
|
682
|
+
# config.rpcs.list_workflows.timeout = 20.0
|
683
|
+
# end
|
684
|
+
#
|
685
|
+
# # Apply the above configuration only to a new client.
|
686
|
+
# client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new do |config|
|
687
|
+
# config.timeout = 10.0
|
688
|
+
# config.rpcs.list_workflows.timeout = 20.0
|
689
|
+
# end
|
575
690
|
#
|
576
691
|
# @!attribute [rw] endpoint
|
577
692
|
# The hostname or hostname:port of the service endpoint.
|
@@ -82,7 +82,7 @@ module Google
|
|
82
82
|
# Create credentials
|
83
83
|
credentials = @config.credentials
|
84
84
|
credentials ||= Credentials.default scope: @config.scope
|
85
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
85
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
86
86
|
credentials = Credentials.new credentials, scope: @config.scope
|
87
87
|
end
|
88
88
|
@quota_project_id = @config.quota_project
|
@@ -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,16 +181,20 @@ module Google
|
|
160
181
|
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
161
182
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
162
183
|
|
163
|
-
header_params = {
|
164
|
-
|
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
|
|
169
192
|
options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
|
170
193
|
metadata: metadata,
|
171
194
|
retry_policy: @config.rpcs.list_operations.retry_policy
|
172
|
-
|
195
|
+
|
196
|
+
options.apply_defaults timeout: @config.timeout,
|
197
|
+
metadata: @config.metadata,
|
173
198
|
retry_policy: @config.retry_policy
|
174
199
|
|
175
200
|
@operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
|
@@ -213,6 +238,28 @@ module Google
|
|
213
238
|
#
|
214
239
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
215
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
|
+
#
|
216
263
|
def get_operation request, options = nil
|
217
264
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
218
265
|
|
@@ -230,16 +277,20 @@ module Google
|
|
230
277
|
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
231
278
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
232
279
|
|
233
|
-
header_params = {
|
234
|
-
|
235
|
-
|
280
|
+
header_params = {}
|
281
|
+
if request.name
|
282
|
+
header_params["name"] = request.name
|
283
|
+
end
|
284
|
+
|
236
285
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
237
286
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
238
287
|
|
239
288
|
options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
|
240
289
|
metadata: metadata,
|
241
290
|
retry_policy: @config.rpcs.get_operation.retry_policy
|
242
|
-
|
291
|
+
|
292
|
+
options.apply_defaults timeout: @config.timeout,
|
293
|
+
metadata: @config.metadata,
|
243
294
|
retry_policy: @config.retry_policy
|
244
295
|
|
245
296
|
@operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
|
@@ -283,6 +334,21 @@ module Google
|
|
283
334
|
#
|
284
335
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
285
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
|
+
#
|
286
352
|
def delete_operation request, options = nil
|
287
353
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
288
354
|
|
@@ -300,16 +366,20 @@ module Google
|
|
300
366
|
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
301
367
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
302
368
|
|
303
|
-
header_params = {
|
304
|
-
|
305
|
-
|
369
|
+
header_params = {}
|
370
|
+
if request.name
|
371
|
+
header_params["name"] = request.name
|
372
|
+
end
|
373
|
+
|
306
374
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
307
375
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
308
376
|
|
309
377
|
options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
|
310
378
|
metadata: metadata,
|
311
379
|
retry_policy: @config.rpcs.delete_operation.retry_policy
|
312
|
-
|
380
|
+
|
381
|
+
options.apply_defaults timeout: @config.timeout,
|
382
|
+
metadata: @config.metadata,
|
313
383
|
retry_policy: @config.retry_policy
|
314
384
|
|
315
385
|
@operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
|
@@ -358,6 +428,21 @@ module Google
|
|
358
428
|
#
|
359
429
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
360
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
|
+
#
|
361
446
|
def cancel_operation request, options = nil
|
362
447
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
363
448
|
|
@@ -375,16 +460,20 @@ module Google
|
|
375
460
|
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
376
461
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
377
462
|
|
378
|
-
header_params = {
|
379
|
-
|
380
|
-
|
463
|
+
header_params = {}
|
464
|
+
if request.name
|
465
|
+
header_params["name"] = request.name
|
466
|
+
end
|
467
|
+
|
381
468
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
382
469
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
383
470
|
|
384
471
|
options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
|
385
472
|
metadata: metadata,
|
386
473
|
retry_policy: @config.rpcs.cancel_operation.retry_policy
|
387
|
-
|
474
|
+
|
475
|
+
options.apply_defaults timeout: @config.timeout,
|
476
|
+
metadata: @config.metadata,
|
388
477
|
retry_policy: @config.retry_policy
|
389
478
|
|
390
479
|
@operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
|
@@ -396,9 +485,9 @@ module Google
|
|
396
485
|
end
|
397
486
|
|
398
487
|
##
|
399
|
-
# Waits
|
400
|
-
#
|
401
|
-
#
|
488
|
+
# Waits until the specified long-running operation is done or reaches at most
|
489
|
+
# a specified timeout, returning the latest state. If the operation is
|
490
|
+
# already done, the latest state is immediately returned. If the timeout
|
402
491
|
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
403
492
|
# timeout is used. If the server does not support this method, it returns
|
404
493
|
# `google.rpc.Code.UNIMPLEMENTED`.
|
@@ -436,6 +525,28 @@ module Google
|
|
436
525
|
#
|
437
526
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
438
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
|
+
#
|
439
550
|
def wait_operation request, options = nil
|
440
551
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
441
552
|
|
@@ -456,7 +567,9 @@ module Google
|
|
456
567
|
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
457
568
|
metadata: metadata,
|
458
569
|
retry_policy: @config.rpcs.wait_operation.retry_policy
|
459
|
-
|
570
|
+
|
571
|
+
options.apply_defaults timeout: @config.timeout,
|
572
|
+
metadata: @config.metadata,
|
460
573
|
retry_policy: @config.retry_policy
|
461
574
|
|
462
575
|
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
@@ -481,22 +594,21 @@ module Google
|
|
481
594
|
# Configuration can be applied globally to all clients, or to a single client
|
482
595
|
# on construction.
|
483
596
|
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
# to 20 seconds,
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
# end
|
597
|
+
# @example
|
598
|
+
#
|
599
|
+
# # Modify the global config, setting the timeout for
|
600
|
+
# # list_operations to 20 seconds,
|
601
|
+
# # and all remaining timeouts to 10 seconds.
|
602
|
+
# ::Google::Longrunning::Operations::Client.configure do |config|
|
603
|
+
# config.timeout = 10.0
|
604
|
+
# config.rpcs.list_operations.timeout = 20.0
|
605
|
+
# end
|
606
|
+
#
|
607
|
+
# # Apply the above configuration only to a new client.
|
608
|
+
# client = ::Google::Longrunning::Operations::Client.new do |config|
|
609
|
+
# config.timeout = 10.0
|
610
|
+
# config.rpcs.list_operations.timeout = 20.0
|
611
|
+
# end
|
500
612
|
#
|
501
613
|
# @!attribute [rw] endpoint
|
502
614
|
# The hostname or hostname:port of the service endpoint.
|
@@ -1,8 +1,6 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/workflows/v1beta/workflows.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'
|
@@ -10,6 +8,8 @@ require 'google/api/resource_pb'
|
|
10
8
|
require 'google/longrunning/operations_pb'
|
11
9
|
require 'google/protobuf/field_mask_pb'
|
12
10
|
require 'google/protobuf/timestamp_pb'
|
11
|
+
require 'google/protobuf'
|
12
|
+
|
13
13
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
14
|
add_file("google/cloud/workflows/v1beta/workflows.proto", :syntax => :proto3) do
|
15
15
|
add_message "google.cloud.workflows.v1beta.Workflow" do
|
@@ -57,9 +57,15 @@ module Google
|
|
57
57
|
|
58
58
|
# Denotes that a (repeated) field is an unordered list.
|
59
59
|
# This indicates that the service may provide the elements of the list
|
60
|
-
# in any arbitrary
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
61
61
|
# provided. Additionally, the list's order may or may not be stable.
|
62
62
|
UNORDERED_LIST = 6
|
63
|
+
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
67
|
+
# non-empty value to expect.
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
63
69
|
end
|
64
70
|
end
|
65
71
|
end
|
metadata
CHANGED
@@ -1,29 +1,35 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-workflows-v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.3.
|
4
|
+
version: 0.3.4
|
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-
|
11
|
+
date: 2021-11-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- - "
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.7'
|
20
|
+
- - "<"
|
18
21
|
- !ruby/object:Gem::Version
|
19
|
-
version:
|
22
|
+
version: 2.a
|
20
23
|
type: :runtime
|
21
24
|
prerelease: false
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
23
26
|
requirements:
|
24
|
-
- - "
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0.7'
|
30
|
+
- - "<"
|
25
31
|
- !ruby/object:Gem::Version
|
26
|
-
version:
|
32
|
+
version: 2.a
|
27
33
|
- !ruby/object:Gem::Dependency
|
28
34
|
name: google-cloud-errors
|
29
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -206,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
206
212
|
- !ruby/object:Gem::Version
|
207
213
|
version: '0'
|
208
214
|
requirements: []
|
209
|
-
rubygems_version: 3.2.
|
215
|
+
rubygems_version: 3.2.17
|
210
216
|
signing_key:
|
211
217
|
specification_version: 4
|
212
218
|
summary: API Client library for the Workflows V1beta API
|