google-cloud-workflows-v1 0.1.3 → 0.2.0
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.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/README.md +11 -6
- data/lib/google/cloud/workflows/v1/version.rb +1 -1
- data/lib/google/cloud/workflows/v1/workflows/client.rb +128 -15
- data/lib/google/cloud/workflows/v1/workflows/operations.rb +118 -12
- data/lib/google/cloud/workflows/v1/workflows_pb.rb +2 -1
- data/lib/google/cloud/workflows/v1.rb +2 -0
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/protobuf/any.rb +3 -3
- metadata +12 -12
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d9c76290a99871cf47d5f551d605d4f861bb7173401b7b404adcb75f431a758e
|
4
|
+
data.tar.gz: f9efe104d70887b73849b1151358b4464258c75ef328068f3cf8d2d3880dbcd3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d9474611eab96b25926257af917fdcb50fde3b7429628e205ffdeaec938832d96b10fa175a82d3cf192c9b661560ed365cce8b3ad799e7b30f385f967944e61e
|
7
|
+
data.tar.gz: 54c962cbb708e36a808ffd1ac7cbef29e67edeec18b1cc729d94075b621a53e29200cb16302b73e4723f04f96d9cde0b7d92c119f375ab4f2798dc1fc9584ce4
|
data/.yardopts
CHANGED
data/AUTHENTICATION.md
CHANGED
@@ -120,15 +120,6 @@ To configure your system for this, simply:
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
121
121
|
*should* only be used during development.
|
122
122
|
|
123
|
-
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
|
124
|
-
[dev-console]: https://console.cloud.google.com/project
|
125
|
-
|
126
|
-
[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
|
127
|
-
|
128
|
-
[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
|
129
|
-
[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
|
130
|
-
[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
|
131
|
-
|
132
123
|
## Creating a Service Account
|
133
124
|
|
134
125
|
Google Cloud requires **Service Account Credentials** to
|
@@ -139,31 +130,22 @@ If you are not running this client within
|
|
139
130
|
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
140
131
|
need a Google Developers service account.
|
141
132
|
|
142
|
-
1. Visit the [Google
|
133
|
+
1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
|
143
134
|
2. Create a new project or click on an existing project.
|
144
|
-
3. Activate the
|
135
|
+
3. Activate the menu in the upper left and select **APIs & Services**. From
|
145
136
|
here, you will enable the APIs that your application requires.
|
146
137
|
|
147
|
-
![Enable the APIs that your application requires][enable-apis]
|
148
|
-
|
149
138
|
*Note: You may need to enable billing in order to use these services.*
|
150
139
|
|
151
140
|
4. Select **Credentials** from the side navigation.
|
152
141
|
|
153
|
-
|
154
|
-
|
155
|
-
![Create a new service account][create-new-service-account]
|
156
|
-
|
157
|
-
![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
|
158
|
-
|
159
|
-
Find the "Add credentials" drop down and select "Service account" to be
|
160
|
-
guided through downloading a new JSON key file.
|
142
|
+
Find the "Create credentials" drop down near the top of the page, and select
|
143
|
+
"Service account" to be guided through downloading a new JSON key file.
|
161
144
|
|
162
145
|
If you want to re-use an existing service account, you can easily generate a
|
163
|
-
new key file. Just select the account you wish to re-use,
|
164
|
-
|
165
|
-
|
166
|
-
![Re-use an existing service account][reuse-service-account]
|
146
|
+
new key file. Just select the account you wish to re-use, click the pencil
|
147
|
+
tool on the right side to edit the service account, select the **Keys** tab,
|
148
|
+
and then select **Add Key**.
|
167
149
|
|
168
150
|
The key file you download will be used by this library to authenticate API
|
169
151
|
requests and should be stored in a secure location.
|
data/README.md
CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Workflows::V1::ListWorkflowsRequest.new # (request fi
|
|
37
37
|
response = client.list_workflows request
|
38
38
|
```
|
39
39
|
|
40
|
-
View the [Client Library Documentation](https://
|
40
|
+
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest)
|
41
41
|
for class and method documentation.
|
42
42
|
|
43
43
|
See also the [Product Documentation](https://cloud.google.com/workflows/)
|
@@ -69,16 +69,21 @@ module GRPC
|
|
69
69
|
end
|
70
70
|
```
|
71
71
|
|
72
|
+
|
73
|
+
## Google Cloud Samples
|
74
|
+
|
75
|
+
To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
|
76
|
+
|
72
77
|
## Supported Ruby Versions
|
73
78
|
|
74
|
-
This library is supported on Ruby 2.
|
79
|
+
This library is supported on Ruby 2.6+.
|
75
80
|
|
76
81
|
Google provides official support for Ruby versions that are actively supported
|
77
82
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
78
|
-
in security maintenance, and not end of life.
|
79
|
-
|
80
|
-
|
81
|
-
|
83
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
84
|
+
still work, but are unsupported and not recommended. See
|
85
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
86
|
+
support schedule.
|
82
87
|
|
83
88
|
## Which client should I use?
|
84
89
|
|
@@ -137,6 +137,7 @@ module Google
|
|
137
137
|
|
138
138
|
@operations_client = Operations.new do |config|
|
139
139
|
config.credentials = credentials
|
140
|
+
config.quota_project = @quota_project_id
|
140
141
|
config.endpoint = @config.endpoint
|
141
142
|
end
|
142
143
|
|
@@ -207,6 +208,27 @@ module Google
|
|
207
208
|
#
|
208
209
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
209
210
|
#
|
211
|
+
# @example Basic example
|
212
|
+
# require "google/cloud/workflows/v1"
|
213
|
+
#
|
214
|
+
# # Create a client object. The client can be reused for multiple calls.
|
215
|
+
# client = Google::Cloud::Workflows::V1::Workflows::Client.new
|
216
|
+
#
|
217
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
218
|
+
# request = Google::Cloud::Workflows::V1::ListWorkflowsRequest.new
|
219
|
+
#
|
220
|
+
# # Call the list_workflows method.
|
221
|
+
# result = client.list_workflows request
|
222
|
+
#
|
223
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
224
|
+
# # iterate over all elements by calling #each, and the enumerable
|
225
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
226
|
+
# # methods are also available for managing paging directly.
|
227
|
+
# result.each do |response|
|
228
|
+
# # Each element is of type ::Google::Cloud::Workflows::V1::Workflow.
|
229
|
+
# p response
|
230
|
+
# end
|
231
|
+
#
|
210
232
|
def list_workflows request, options = nil
|
211
233
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
212
234
|
|
@@ -224,9 +246,11 @@ module Google
|
|
224
246
|
gapic_version: ::Google::Cloud::Workflows::V1::VERSION
|
225
247
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
226
248
|
|
227
|
-
header_params = {
|
228
|
-
|
229
|
-
|
249
|
+
header_params = {}
|
250
|
+
if request.parent
|
251
|
+
header_params["parent"] = request.parent
|
252
|
+
end
|
253
|
+
|
230
254
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
231
255
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
232
256
|
|
@@ -277,6 +301,21 @@ module Google
|
|
277
301
|
#
|
278
302
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
279
303
|
#
|
304
|
+
# @example Basic example
|
305
|
+
# require "google/cloud/workflows/v1"
|
306
|
+
#
|
307
|
+
# # Create a client object. The client can be reused for multiple calls.
|
308
|
+
# client = Google::Cloud::Workflows::V1::Workflows::Client.new
|
309
|
+
#
|
310
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
311
|
+
# request = Google::Cloud::Workflows::V1::GetWorkflowRequest.new
|
312
|
+
#
|
313
|
+
# # Call the get_workflow method.
|
314
|
+
# result = client.get_workflow request
|
315
|
+
#
|
316
|
+
# # The returned object is of type Google::Cloud::Workflows::V1::Workflow.
|
317
|
+
# p result
|
318
|
+
#
|
280
319
|
def get_workflow request, options = nil
|
281
320
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
282
321
|
|
@@ -294,9 +333,11 @@ module Google
|
|
294
333
|
gapic_version: ::Google::Cloud::Workflows::V1::VERSION
|
295
334
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
296
335
|
|
297
|
-
header_params = {
|
298
|
-
|
299
|
-
|
336
|
+
header_params = {}
|
337
|
+
if request.name
|
338
|
+
header_params["name"] = request.name
|
339
|
+
end
|
340
|
+
|
300
341
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
301
342
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
302
343
|
|
@@ -359,6 +400,28 @@ module Google
|
|
359
400
|
#
|
360
401
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
361
402
|
#
|
403
|
+
# @example Basic example
|
404
|
+
# require "google/cloud/workflows/v1"
|
405
|
+
#
|
406
|
+
# # Create a client object. The client can be reused for multiple calls.
|
407
|
+
# client = Google::Cloud::Workflows::V1::Workflows::Client.new
|
408
|
+
#
|
409
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
410
|
+
# request = Google::Cloud::Workflows::V1::CreateWorkflowRequest.new
|
411
|
+
#
|
412
|
+
# # Call the create_workflow method.
|
413
|
+
# result = client.create_workflow request
|
414
|
+
#
|
415
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
416
|
+
# # object to check the status of an operation, cancel it, or wait
|
417
|
+
# # for results. Here is how to block until completion:
|
418
|
+
# result.wait_until_done! timeout: 60
|
419
|
+
# if result.response?
|
420
|
+
# p result.response
|
421
|
+
# else
|
422
|
+
# puts "Error!"
|
423
|
+
# end
|
424
|
+
#
|
362
425
|
def create_workflow request, options = nil
|
363
426
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
364
427
|
|
@@ -376,9 +439,11 @@ module Google
|
|
376
439
|
gapic_version: ::Google::Cloud::Workflows::V1::VERSION
|
377
440
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
378
441
|
|
379
|
-
header_params = {
|
380
|
-
|
381
|
-
|
442
|
+
header_params = {}
|
443
|
+
if request.parent
|
444
|
+
header_params["parent"] = request.parent
|
445
|
+
end
|
446
|
+
|
382
447
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
383
448
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
384
449
|
|
@@ -431,6 +496,28 @@ module Google
|
|
431
496
|
#
|
432
497
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
433
498
|
#
|
499
|
+
# @example Basic example
|
500
|
+
# require "google/cloud/workflows/v1"
|
501
|
+
#
|
502
|
+
# # Create a client object. The client can be reused for multiple calls.
|
503
|
+
# client = Google::Cloud::Workflows::V1::Workflows::Client.new
|
504
|
+
#
|
505
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
506
|
+
# request = Google::Cloud::Workflows::V1::DeleteWorkflowRequest.new
|
507
|
+
#
|
508
|
+
# # Call the delete_workflow method.
|
509
|
+
# result = client.delete_workflow request
|
510
|
+
#
|
511
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
512
|
+
# # object to check the status of an operation, cancel it, or wait
|
513
|
+
# # for results. Here is how to block until completion:
|
514
|
+
# result.wait_until_done! timeout: 60
|
515
|
+
# if result.response?
|
516
|
+
# p result.response
|
517
|
+
# else
|
518
|
+
# puts "Error!"
|
519
|
+
# end
|
520
|
+
#
|
434
521
|
def delete_workflow request, options = nil
|
435
522
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
436
523
|
|
@@ -448,9 +535,11 @@ module Google
|
|
448
535
|
gapic_version: ::Google::Cloud::Workflows::V1::VERSION
|
449
536
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
450
537
|
|
451
|
-
header_params = {
|
452
|
-
|
453
|
-
|
538
|
+
header_params = {}
|
539
|
+
if request.name
|
540
|
+
header_params["name"] = request.name
|
541
|
+
end
|
542
|
+
|
454
543
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
455
544
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
456
545
|
|
@@ -507,6 +596,28 @@ module Google
|
|
507
596
|
#
|
508
597
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
509
598
|
#
|
599
|
+
# @example Basic example
|
600
|
+
# require "google/cloud/workflows/v1"
|
601
|
+
#
|
602
|
+
# # Create a client object. The client can be reused for multiple calls.
|
603
|
+
# client = Google::Cloud::Workflows::V1::Workflows::Client.new
|
604
|
+
#
|
605
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
606
|
+
# request = Google::Cloud::Workflows::V1::UpdateWorkflowRequest.new
|
607
|
+
#
|
608
|
+
# # Call the update_workflow method.
|
609
|
+
# result = client.update_workflow request
|
610
|
+
#
|
611
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
612
|
+
# # object to check the status of an operation, cancel it, or wait
|
613
|
+
# # for results. Here is how to block until completion:
|
614
|
+
# result.wait_until_done! timeout: 60
|
615
|
+
# if result.response?
|
616
|
+
# p result.response
|
617
|
+
# else
|
618
|
+
# puts "Error!"
|
619
|
+
# end
|
620
|
+
#
|
510
621
|
def update_workflow request, options = nil
|
511
622
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
512
623
|
|
@@ -524,9 +635,11 @@ module Google
|
|
524
635
|
gapic_version: ::Google::Cloud::Workflows::V1::VERSION
|
525
636
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
526
637
|
|
527
|
-
header_params = {
|
528
|
-
|
529
|
-
|
638
|
+
header_params = {}
|
639
|
+
if request.workflow&.name
|
640
|
+
header_params["workflow.name"] = request.workflow.name
|
641
|
+
end
|
642
|
+
|
530
643
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
531
644
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
532
645
|
|
@@ -95,6 +95,9 @@ module Google
|
|
95
95
|
channel_args: @config.channel_args,
|
96
96
|
interceptors: @config.interceptors
|
97
97
|
)
|
98
|
+
|
99
|
+
# Used by an LRO wrapper for some methods of this service
|
100
|
+
@operations_client = self
|
98
101
|
end
|
99
102
|
|
100
103
|
# Service calls
|
@@ -143,6 +146,27 @@ module Google
|
|
143
146
|
#
|
144
147
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
145
148
|
#
|
149
|
+
# @example Basic example
|
150
|
+
# require "google/longrunning"
|
151
|
+
#
|
152
|
+
# # Create a client object. The client can be reused for multiple calls.
|
153
|
+
# client = Google::Longrunning::Operations::Client.new
|
154
|
+
#
|
155
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
156
|
+
# request = Google::Longrunning::ListOperationsRequest.new
|
157
|
+
#
|
158
|
+
# # Call the list_operations method.
|
159
|
+
# result = client.list_operations request
|
160
|
+
#
|
161
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
162
|
+
# # iterate over all elements by calling #each, and the enumerable
|
163
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
164
|
+
# # methods are also available for managing paging directly.
|
165
|
+
# result.each do |response|
|
166
|
+
# # Each element is of type ::Google::Longrunning::Operation.
|
167
|
+
# p response
|
168
|
+
# end
|
169
|
+
#
|
146
170
|
def list_operations request, options = nil
|
147
171
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
148
172
|
|
@@ -160,9 +184,11 @@ module Google
|
|
160
184
|
gapic_version: ::Google::Cloud::Workflows::V1::VERSION
|
161
185
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
162
186
|
|
163
|
-
header_params = {
|
164
|
-
|
165
|
-
|
187
|
+
header_params = {}
|
188
|
+
if request.name
|
189
|
+
header_params["name"] = request.name
|
190
|
+
end
|
191
|
+
|
166
192
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
167
193
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
168
194
|
|
@@ -215,6 +241,28 @@ module Google
|
|
215
241
|
#
|
216
242
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
217
243
|
#
|
244
|
+
# @example Basic example
|
245
|
+
# require "google/longrunning"
|
246
|
+
#
|
247
|
+
# # Create a client object. The client can be reused for multiple calls.
|
248
|
+
# client = Google::Longrunning::Operations::Client.new
|
249
|
+
#
|
250
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
251
|
+
# request = Google::Longrunning::GetOperationRequest.new
|
252
|
+
#
|
253
|
+
# # Call the get_operation method.
|
254
|
+
# result = client.get_operation request
|
255
|
+
#
|
256
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
257
|
+
# # object to check the status of an operation, cancel it, or wait
|
258
|
+
# # for results. Here is how to block until completion:
|
259
|
+
# result.wait_until_done! timeout: 60
|
260
|
+
# if result.response?
|
261
|
+
# p result.response
|
262
|
+
# else
|
263
|
+
# puts "Error!"
|
264
|
+
# end
|
265
|
+
#
|
218
266
|
def get_operation request, options = nil
|
219
267
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
220
268
|
|
@@ -232,9 +280,11 @@ module Google
|
|
232
280
|
gapic_version: ::Google::Cloud::Workflows::V1::VERSION
|
233
281
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
234
282
|
|
235
|
-
header_params = {
|
236
|
-
|
237
|
-
|
283
|
+
header_params = {}
|
284
|
+
if request.name
|
285
|
+
header_params["name"] = request.name
|
286
|
+
end
|
287
|
+
|
238
288
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
239
289
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
240
290
|
|
@@ -287,6 +337,21 @@ module Google
|
|
287
337
|
#
|
288
338
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
289
339
|
#
|
340
|
+
# @example Basic example
|
341
|
+
# require "google/longrunning"
|
342
|
+
#
|
343
|
+
# # Create a client object. The client can be reused for multiple calls.
|
344
|
+
# client = Google::Longrunning::Operations::Client.new
|
345
|
+
#
|
346
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
347
|
+
# request = Google::Longrunning::DeleteOperationRequest.new
|
348
|
+
#
|
349
|
+
# # Call the delete_operation method.
|
350
|
+
# result = client.delete_operation request
|
351
|
+
#
|
352
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
353
|
+
# p result
|
354
|
+
#
|
290
355
|
def delete_operation request, options = nil
|
291
356
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
292
357
|
|
@@ -304,9 +369,11 @@ module Google
|
|
304
369
|
gapic_version: ::Google::Cloud::Workflows::V1::VERSION
|
305
370
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
306
371
|
|
307
|
-
header_params = {
|
308
|
-
|
309
|
-
|
372
|
+
header_params = {}
|
373
|
+
if request.name
|
374
|
+
header_params["name"] = request.name
|
375
|
+
end
|
376
|
+
|
310
377
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
311
378
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
312
379
|
|
@@ -364,6 +431,21 @@ module Google
|
|
364
431
|
#
|
365
432
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
366
433
|
#
|
434
|
+
# @example Basic example
|
435
|
+
# require "google/longrunning"
|
436
|
+
#
|
437
|
+
# # Create a client object. The client can be reused for multiple calls.
|
438
|
+
# client = Google::Longrunning::Operations::Client.new
|
439
|
+
#
|
440
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
441
|
+
# request = Google::Longrunning::CancelOperationRequest.new
|
442
|
+
#
|
443
|
+
# # Call the cancel_operation method.
|
444
|
+
# result = client.cancel_operation request
|
445
|
+
#
|
446
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
447
|
+
# p result
|
448
|
+
#
|
367
449
|
def cancel_operation request, options = nil
|
368
450
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
369
451
|
|
@@ -381,9 +463,11 @@ module Google
|
|
381
463
|
gapic_version: ::Google::Cloud::Workflows::V1::VERSION
|
382
464
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
383
465
|
|
384
|
-
header_params = {
|
385
|
-
|
386
|
-
|
466
|
+
header_params = {}
|
467
|
+
if request.name
|
468
|
+
header_params["name"] = request.name
|
469
|
+
end
|
470
|
+
|
387
471
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
388
472
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
389
473
|
|
@@ -444,6 +528,28 @@ module Google
|
|
444
528
|
#
|
445
529
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
446
530
|
#
|
531
|
+
# @example Basic example
|
532
|
+
# require "google/longrunning"
|
533
|
+
#
|
534
|
+
# # Create a client object. The client can be reused for multiple calls.
|
535
|
+
# client = Google::Longrunning::Operations::Client.new
|
536
|
+
#
|
537
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
538
|
+
# request = Google::Longrunning::WaitOperationRequest.new
|
539
|
+
#
|
540
|
+
# # Call the wait_operation method.
|
541
|
+
# result = client.wait_operation request
|
542
|
+
#
|
543
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
544
|
+
# # object to check the status of an operation, cancel it, or wait
|
545
|
+
# # for results. Here is how to block until completion:
|
546
|
+
# result.wait_until_done! timeout: 60
|
547
|
+
# if result.response?
|
548
|
+
# p result.response
|
549
|
+
# else
|
550
|
+
# puts "Error!"
|
551
|
+
# end
|
552
|
+
#
|
447
553
|
def wait_operation request, options = nil
|
448
554
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
449
555
|
|
@@ -1,6 +1,8 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/workflows/v1/workflows.proto
|
3
3
|
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
4
6
|
require 'google/api/annotations_pb'
|
5
7
|
require 'google/api/client_pb'
|
6
8
|
require 'google/api/field_behavior_pb'
|
@@ -8,7 +10,6 @@ require 'google/api/resource_pb'
|
|
8
10
|
require 'google/longrunning/operations_pb'
|
9
11
|
require 'google/protobuf/field_mask_pb'
|
10
12
|
require 'google/protobuf/timestamp_pb'
|
11
|
-
require 'google/protobuf'
|
12
13
|
|
13
14
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
15
|
add_file("google/cloud/workflows/v1/workflows.proto", :syntax => :proto3) do
|
@@ -33,11 +33,7 @@ module Google
|
|
33
33
|
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
34
|
# option (google.api.resource) = {
|
35
35
|
# type: "pubsub.googleapis.com/Topic"
|
36
|
-
#
|
37
|
-
# pattern: "projects/{project}/topics/{topic}"
|
38
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
-
# parent_name_extractor: "projects/{project}"
|
40
|
-
# }
|
36
|
+
# pattern: "projects/{project}/topics/{topic}"
|
41
37
|
# };
|
42
38
|
# }
|
43
39
|
#
|
@@ -45,10 +41,7 @@ module Google
|
|
45
41
|
#
|
46
42
|
# resources:
|
47
43
|
# - type: "pubsub.googleapis.com/Topic"
|
48
|
-
#
|
49
|
-
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
-
# parent_name_extractor: "projects/{project}"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
52
45
|
#
|
53
46
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
47
|
# live under multiple parents.
|
@@ -58,26 +51,10 @@ module Google
|
|
58
51
|
# message LogEntry {
|
59
52
|
# option (google.api.resource) = {
|
60
53
|
# type: "logging.googleapis.com/LogEntry"
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
# }
|
66
|
-
# name_descriptor: {
|
67
|
-
# pattern: "folders/{folder}/logs/{log}"
|
68
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
-
# parent_name_extractor: "folders/{folder}"
|
70
|
-
# }
|
71
|
-
# name_descriptor: {
|
72
|
-
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
-
# parent_name_extractor: "organizations/{organization}"
|
75
|
-
# }
|
76
|
-
# name_descriptor: {
|
77
|
-
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
-
# }
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
81
58
|
# };
|
82
59
|
# }
|
83
60
|
#
|
@@ -85,48 +62,10 @@ module Google
|
|
85
62
|
#
|
86
63
|
# resources:
|
87
64
|
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
-
# parent_name_extractor: "folders/{folder}"
|
95
|
-
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
-
# parent_name_extractor: "organizations/{organization}"
|
98
|
-
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
-
#
|
102
|
-
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
-
# the resource itself has parents for policy evaluation.
|
104
|
-
#
|
105
|
-
# Example:
|
106
|
-
#
|
107
|
-
# message Shelf {
|
108
|
-
# option (google.api.resource) = {
|
109
|
-
# type: "library.googleapis.com/Shelf"
|
110
|
-
# name_descriptor: {
|
111
|
-
# pattern: "shelves/{shelf}"
|
112
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
-
# }
|
114
|
-
# name_descriptor: {
|
115
|
-
# pattern: "shelves/{shelf}"
|
116
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
-
# }
|
118
|
-
# };
|
119
|
-
# }
|
120
|
-
#
|
121
|
-
# The ResourceDescriptor Yaml config will look like:
|
122
|
-
#
|
123
|
-
# resources:
|
124
|
-
# - type: 'library.googleapis.com/Shelf'
|
125
|
-
# name_descriptor:
|
126
|
-
# - pattern: "shelves/{shelf}"
|
127
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
-
# - pattern: "shelves/{shelf}"
|
129
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
130
69
|
# @!attribute [rw] type
|
131
70
|
# @return [::String]
|
132
71
|
# The resource type. It must be in the format of
|
@@ -44,7 +44,7 @@ module Google
|
|
44
44
|
# foo = any.unpack(Foo.class);
|
45
45
|
# }
|
46
46
|
#
|
47
|
-
#
|
47
|
+
# Example 3: Pack and unpack a message in Python.
|
48
48
|
#
|
49
49
|
# foo = Foo(...)
|
50
50
|
# any = Any()
|
@@ -54,7 +54,7 @@ module Google
|
|
54
54
|
# any.Unpack(foo)
|
55
55
|
# ...
|
56
56
|
#
|
57
|
-
#
|
57
|
+
# Example 4: Pack and unpack a message in Go
|
58
58
|
#
|
59
59
|
# foo := &pb.Foo{...}
|
60
60
|
# any, err := anypb.New(foo)
|
@@ -75,7 +75,7 @@ module Google
|
|
75
75
|
#
|
76
76
|
#
|
77
77
|
# JSON
|
78
|
-
#
|
78
|
+
#
|
79
79
|
# The JSON representation of an `Any` value uses the regular
|
80
80
|
# representation of the deserialized, embedded message, with an
|
81
81
|
# additional field `@type` which contains the type URL. Example:
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-workflows-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-07-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.10'
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: '0.
|
29
|
+
version: '0.10'
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -50,28 +50,28 @@ dependencies:
|
|
50
50
|
requirements:
|
51
51
|
- - "~>"
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: 1.
|
53
|
+
version: 1.26.1
|
54
54
|
type: :development
|
55
55
|
prerelease: false
|
56
56
|
version_requirements: !ruby/object:Gem::Requirement
|
57
57
|
requirements:
|
58
58
|
- - "~>"
|
59
59
|
- !ruby/object:Gem::Version
|
60
|
-
version: 1.
|
60
|
+
version: 1.26.1
|
61
61
|
- !ruby/object:Gem::Dependency
|
62
62
|
name: minitest
|
63
63
|
requirement: !ruby/object:Gem::Requirement
|
64
64
|
requirements:
|
65
65
|
- - "~>"
|
66
66
|
- !ruby/object:Gem::Version
|
67
|
-
version: '5.
|
67
|
+
version: '5.16'
|
68
68
|
type: :development
|
69
69
|
prerelease: false
|
70
70
|
version_requirements: !ruby/object:Gem::Requirement
|
71
71
|
requirements:
|
72
72
|
- - "~>"
|
73
73
|
- !ruby/object:Gem::Version
|
74
|
-
version: '5.
|
74
|
+
version: '5.16'
|
75
75
|
- !ruby/object:Gem::Dependency
|
76
76
|
name: minitest-focus
|
77
77
|
requirement: !ruby/object:Gem::Requirement
|
@@ -106,14 +106,14 @@ dependencies:
|
|
106
106
|
requirements:
|
107
107
|
- - ">="
|
108
108
|
- !ruby/object:Gem::Version
|
109
|
-
version: '
|
109
|
+
version: '13.0'
|
110
110
|
type: :development
|
111
111
|
prerelease: false
|
112
112
|
version_requirements: !ruby/object:Gem::Requirement
|
113
113
|
requirements:
|
114
114
|
- - ">="
|
115
115
|
- !ruby/object:Gem::Version
|
116
|
-
version: '
|
116
|
+
version: '13.0'
|
117
117
|
- !ruby/object:Gem::Dependency
|
118
118
|
name: redcarpet
|
119
119
|
requirement: !ruby/object:Gem::Requirement
|
@@ -205,14 +205,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
205
205
|
requirements:
|
206
206
|
- - ">="
|
207
207
|
- !ruby/object:Gem::Version
|
208
|
-
version: '2.
|
208
|
+
version: '2.6'
|
209
209
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
210
210
|
requirements:
|
211
211
|
- - ">="
|
212
212
|
- !ruby/object:Gem::Version
|
213
213
|
version: '0'
|
214
214
|
requirements: []
|
215
|
-
rubygems_version: 3.
|
215
|
+
rubygems_version: 3.3.14
|
216
216
|
signing_key:
|
217
217
|
specification_version: 4
|
218
218
|
summary: API Client library for the Workflows V1 API
|