google-cloud-workflows-v1beta 0.3.1 → 0.3.5

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0d991700062e93adeed8040e7d094649bdf0c7aed999de7c51619b9150ba6f24
4
- data.tar.gz: bdbd2a09dea749f32490c255ea4381ff5a125b45c9bcae04e6c3cf650883873f
3
+ metadata.gz: 245a7781533d6cb6fb7e2f0c797f96473e92f9ccd63cdc2617c3cc007cfea46c
4
+ data.tar.gz: 9c2e54657207503ca1acbd115806d5696c06c3551f88588fb235ca304e836ce6
5
5
  SHA512:
6
- metadata.gz: 954b2f39846f0292d70746ce7ddf38ffbbabc9cd89ccc3fc0679a862d90219dab366617cdf1307b00476ba569c19169524ee0a491a094610e05866fd90cdd70d
7
- data.tar.gz: 3c9ad72e307ba54a71060df895f42edf73f28545e832ba7e3120e96435ef36c9051895eb5151d13736ef3aee815147e774b9f96fc188eabe39fd9299a8c9e24a
6
+ metadata.gz: 5804dada24a2fd28e6f6cc01df05283dea8a0f00362d4b29afc4427794a4a324dda7bffbfbd97010ff366bb710d513206dbc8324c55816af5fe92302dd8d22bd
7
+ data.tar.gz: aa53a9a012452ca9e2a3d598de3b4cc47390e33fab79c23282b92c6640c57f3b886b00451be419d325d76fb3c8803cb6dc8f537b04a669fa06a10a17bff49e21
data/.yardopts CHANGED
@@ -1,5 +1,5 @@
1
1
  --no-private
2
- --title=Workflows V1beta API
2
+ --title="Workflows V1beta API"
3
3
  --exclude _pb\.rb$
4
4
  --markup markdown
5
5
  --markup-provider redcarpet
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
- 1. `WORKFLOWS_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `WORKFLOWS_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
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 placing them in
86
- environment variables. Either on an individual client initialization:
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 configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/workflows/v1beta"
@@ -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 Developers Console][dev-console].
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 slide-out navigation tray and select **API Manager**. From
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
- You should see a screen like one of the following.
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, and click "Generate
164
- new JSON key":
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
@@ -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 = my_create_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
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Workflows
23
23
  module V1beta
24
- VERSION = "0.3.1"
24
+ VERSION = "0.3.5"
25
25
  end
26
26
  end
27
27
  end
@@ -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
- # ## Example
46
+ # @example
47
47
  #
48
- # To modify the configuration for all Workflows clients:
49
- #
50
- # ::Google::Cloud::Workflows::V1beta::Workflows::Client.configure do |config|
51
- # config.timeout = 10.0
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
- # ## Examples
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
- # To create a new Workflows client with a custom
107
- # configuration:
100
+ # # Create a client using the default configuration
101
+ # client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new
108
102
  #
109
- # client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new do |config|
110
- # config.timeout = 10.0
111
- # end
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 scope and endpoint are unchanged from default,
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.scope == Client.configure.scope &&
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
@@ -143,6 +137,7 @@ module Google
143
137
 
144
138
  @operations_client = Operations.new do |config|
145
139
  config.credentials = credentials
140
+ config.quota_project = @quota_project_id
146
141
  config.endpoint = @config.endpoint
147
142
  end
148
143
 
@@ -213,6 +208,27 @@ module Google
213
208
  #
214
209
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
215
210
  #
211
+ # @example Basic example
212
+ # require "google/cloud/workflows/v1beta"
213
+ #
214
+ # # Create a client object. The client can be reused for multiple calls.
215
+ # client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
216
+ #
217
+ # # Create a request. To set request fields, pass in keyword arguments.
218
+ # request = Google::Cloud::Workflows::V1beta::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::V1beta::Workflow.
229
+ # p response
230
+ # end
231
+ #
216
232
  def list_workflows request, options = nil
217
233
  raise ::ArgumentError, "request must be provided" if request.nil?
218
234
 
@@ -230,16 +246,20 @@ module Google
230
246
  gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
231
247
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
232
248
 
233
- header_params = {
234
- "parent" => request.parent
235
- }
249
+ header_params = {}
250
+ if request.parent
251
+ header_params["parent"] = request.parent
252
+ end
253
+
236
254
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
237
255
  metadata[:"x-goog-request-params"] ||= request_params_header
238
256
 
239
257
  options.apply_defaults timeout: @config.rpcs.list_workflows.timeout,
240
258
  metadata: metadata,
241
259
  retry_policy: @config.rpcs.list_workflows.retry_policy
242
- options.apply_defaults metadata: @config.metadata,
260
+
261
+ options.apply_defaults timeout: @config.timeout,
262
+ metadata: @config.metadata,
243
263
  retry_policy: @config.retry_policy
244
264
 
245
265
  @workflows_stub.call_rpc :list_workflows, request, options: options do |response, operation|
@@ -281,6 +301,21 @@ module Google
281
301
  #
282
302
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
283
303
  #
304
+ # @example Basic example
305
+ # require "google/cloud/workflows/v1beta"
306
+ #
307
+ # # Create a client object. The client can be reused for multiple calls.
308
+ # client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
309
+ #
310
+ # # Create a request. To set request fields, pass in keyword arguments.
311
+ # request = Google::Cloud::Workflows::V1beta::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::V1beta::Workflow.
317
+ # p result
318
+ #
284
319
  def get_workflow request, options = nil
285
320
  raise ::ArgumentError, "request must be provided" if request.nil?
286
321
 
@@ -298,16 +333,20 @@ module Google
298
333
  gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
299
334
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
300
335
 
301
- header_params = {
302
- "name" => request.name
303
- }
336
+ header_params = {}
337
+ if request.name
338
+ header_params["name"] = request.name
339
+ end
340
+
304
341
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
305
342
  metadata[:"x-goog-request-params"] ||= request_params_header
306
343
 
307
344
  options.apply_defaults timeout: @config.rpcs.get_workflow.timeout,
308
345
  metadata: metadata,
309
346
  retry_policy: @config.rpcs.get_workflow.retry_policy
310
- options.apply_defaults metadata: @config.metadata,
347
+
348
+ options.apply_defaults timeout: @config.timeout,
349
+ metadata: @config.metadata,
311
350
  retry_policy: @config.retry_policy
312
351
 
313
352
  @workflows_stub.call_rpc :get_workflow, request, options: options do |response, operation|
@@ -361,6 +400,28 @@ module Google
361
400
  #
362
401
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
363
402
  #
403
+ # @example Basic example
404
+ # require "google/cloud/workflows/v1beta"
405
+ #
406
+ # # Create a client object. The client can be reused for multiple calls.
407
+ # client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
408
+ #
409
+ # # Create a request. To set request fields, pass in keyword arguments.
410
+ # request = Google::Cloud::Workflows::V1beta::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
+ #
364
425
  def create_workflow request, options = nil
365
426
  raise ::ArgumentError, "request must be provided" if request.nil?
366
427
 
@@ -378,16 +439,20 @@ module Google
378
439
  gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
379
440
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
380
441
 
381
- header_params = {
382
- "parent" => request.parent
383
- }
442
+ header_params = {}
443
+ if request.parent
444
+ header_params["parent"] = request.parent
445
+ end
446
+
384
447
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
385
448
  metadata[:"x-goog-request-params"] ||= request_params_header
386
449
 
387
450
  options.apply_defaults timeout: @config.rpcs.create_workflow.timeout,
388
451
  metadata: metadata,
389
452
  retry_policy: @config.rpcs.create_workflow.retry_policy
390
- options.apply_defaults metadata: @config.metadata,
453
+
454
+ options.apply_defaults timeout: @config.timeout,
455
+ metadata: @config.metadata,
391
456
  retry_policy: @config.retry_policy
392
457
 
393
458
  @workflows_stub.call_rpc :create_workflow, request, options: options do |response, operation|
@@ -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/v1beta"
501
+ #
502
+ # # Create a client object. The client can be reused for multiple calls.
503
+ # client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
504
+ #
505
+ # # Create a request. To set request fields, pass in keyword arguments.
506
+ # request = Google::Cloud::Workflows::V1beta::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,16 +535,20 @@ module Google
448
535
  gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
449
536
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
450
537
 
451
- header_params = {
452
- "name" => request.name
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
 
457
546
  options.apply_defaults timeout: @config.rpcs.delete_workflow.timeout,
458
547
  metadata: metadata,
459
548
  retry_policy: @config.rpcs.delete_workflow.retry_policy
460
- options.apply_defaults metadata: @config.metadata,
549
+
550
+ options.apply_defaults timeout: @config.timeout,
551
+ metadata: @config.metadata,
461
552
  retry_policy: @config.retry_policy
462
553
 
463
554
  @workflows_stub.call_rpc :delete_workflow, request, options: options do |response, operation|
@@ -505,6 +596,28 @@ module Google
505
596
  #
506
597
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
507
598
  #
599
+ # @example Basic example
600
+ # require "google/cloud/workflows/v1beta"
601
+ #
602
+ # # Create a client object. The client can be reused for multiple calls.
603
+ # client = Google::Cloud::Workflows::V1beta::Workflows::Client.new
604
+ #
605
+ # # Create a request. To set request fields, pass in keyword arguments.
606
+ # request = Google::Cloud::Workflows::V1beta::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
+ #
508
621
  def update_workflow request, options = nil
509
622
  raise ::ArgumentError, "request must be provided" if request.nil?
510
623
 
@@ -522,16 +635,20 @@ module Google
522
635
  gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
523
636
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
524
637
 
525
- header_params = {
526
- "workflow.name" => request.workflow.name
527
- }
638
+ header_params = {}
639
+ if request.workflow&.name
640
+ header_params["workflow.name"] = request.workflow.name
641
+ end
642
+
528
643
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
529
644
  metadata[:"x-goog-request-params"] ||= request_params_header
530
645
 
531
646
  options.apply_defaults timeout: @config.rpcs.update_workflow.timeout,
532
647
  metadata: metadata,
533
648
  retry_policy: @config.rpcs.update_workflow.retry_policy
534
- options.apply_defaults metadata: @config.metadata,
649
+
650
+ options.apply_defaults timeout: @config.timeout,
651
+ metadata: @config.metadata,
535
652
  retry_policy: @config.retry_policy
536
653
 
537
654
  @workflows_stub.call_rpc :update_workflow, request, options: options do |response, operation|
@@ -556,22 +673,21 @@ module Google
556
673
  # Configuration can be applied globally to all clients, or to a single client
557
674
  # on construction.
558
675
  #
559
- # # Examples
560
- #
561
- # To modify the global config, setting the timeout for list_workflows
562
- # to 20 seconds, and all remaining timeouts to 10 seconds:
563
- #
564
- # ::Google::Cloud::Workflows::V1beta::Workflows::Client.configure do |config|
565
- # config.timeout = 10.0
566
- # config.rpcs.list_workflows.timeout = 20.0
567
- # end
568
- #
569
- # To apply the above configuration only to a new client:
570
- #
571
- # client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new do |config|
572
- # config.timeout = 10.0
573
- # config.rpcs.list_workflows.timeout = 20.0
574
- # end
676
+ # @example
677
+ #
678
+ # # Modify the global config, setting the timeout for
679
+ # # list_workflows to 20 seconds,
680
+ # # and all remaining timeouts to 10 seconds.
681
+ # ::Google::Cloud::Workflows::V1beta::Workflows::Client.configure do |config|
682
+ # config.timeout = 10.0
683
+ # config.rpcs.list_workflows.timeout = 20.0
684
+ # end
685
+ #
686
+ # # Apply the above configuration only to a new client.
687
+ # client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new do |config|
688
+ # config.timeout = 10.0
689
+ # config.rpcs.list_workflows.timeout = 20.0
690
+ # end
575
691
  #
576
692
  # @!attribute [rw] endpoint
577
693
  # 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
- "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
 
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
- options.apply_defaults metadata: @config.metadata,
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
- "name" => request.name
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
- options.apply_defaults metadata: @config.metadata,
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
- "name" => request.name
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
- options.apply_defaults metadata: @config.metadata,
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
- "name" => request.name
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
- options.apply_defaults metadata: @config.metadata,
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 for the specified long-running operation until it is done or reaches
400
- # at most a specified timeout, returning the latest state. If the operation
401
- # is already done, the latest state is immediately returned. If the timeout
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
- options.apply_defaults metadata: @config.metadata,
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
- # # Examples
485
- #
486
- # To modify the global config, setting the timeout for list_operations
487
- # to 20 seconds, and all remaining timeouts to 10 seconds:
488
- #
489
- # ::Google::Longrunning::Operations::Client.configure do |config|
490
- # config.timeout = 10.0
491
- # config.rpcs.list_operations.timeout = 20.0
492
- # end
493
- #
494
- # To apply the above configuration only to a new client:
495
- #
496
- # client = ::Google::Longrunning::Operations::Client.new do |config|
497
- # config.timeout = 10.0
498
- # config.rpcs.list_operations.timeout = 20.0
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 order, rather than the order the user originally
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
@@ -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
- # name_descriptor: {
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
- # name_descriptor:
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
- # name_descriptor: {
62
- # pattern: "projects/{project}/logs/{log}"
63
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
- # parent_name_extractor: "projects/{project}"
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
- # name_descriptor:
89
- # - pattern: "projects/{project}/logs/{log}"
90
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
- # parent_name_extractor: "projects/{project}"
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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-workflows-v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.3.5
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-06-17 00:00:00.000000000 Z
11
+ date: 2022-01-11 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.5'
19
+ version: '0.7'
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.5'
29
+ version: '0.7'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
212
212
  - !ruby/object:Gem::Version
213
213
  version: '0'
214
214
  requirements: []
215
- rubygems_version: 3.2.17
215
+ rubygems_version: 3.3.4
216
216
  signing_key:
217
217
  specification_version: 4
218
218
  summary: API Client library for the Workflows V1beta API