google-cloud-workflows-v1 0.1.5 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +13 -8
- data/lib/google/cloud/workflows/v1/rest.rb +37 -0
- data/lib/google/cloud/workflows/v1/version.rb +1 -1
- data/lib/google/cloud/workflows/v1/workflows/client.rb +16 -18
- data/lib/google/cloud/workflows/v1/workflows/operations.rb +15 -14
- data/lib/google/cloud/workflows/v1/workflows/rest/client.rb +683 -0
- data/lib/google/cloud/workflows/v1/workflows/rest/operations.rb +793 -0
- data/lib/google/cloud/workflows/v1/workflows/rest/service_stub.rb +345 -0
- data/lib/google/cloud/workflows/v1/workflows/rest.rb +55 -0
- data/lib/google/cloud/workflows/v1/workflows.rb +7 -1
- data/lib/google/cloud/workflows/v1/workflows_pb.rb +2 -1
- data/lib/google/cloud/workflows/v1.rb +8 -1
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/protobuf/any.rb +3 -3
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +21 -13
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3d2cc7ed26bae9d6cfad4da5f7495ed52927d81adff15dc9c7215217dcfe20d6
|
4
|
+
data.tar.gz: d209448f7de93fd813ff1b7f1223c7cea4204162294a58685a33d6f91a393ceb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4ee7db19644632effd68696007c4454d311b1aa69aa654a9ff66a925bb4f46fa5e36e9b20a7fdbbd31cab48758f0a70cae4d89ad0eef4587a2eeb2f5d912a247
|
7
|
+
data.tar.gz: 3ed7673f9e137dfb92b6b74d89aa8419e7c810f563db4040bb7c09f504fc9264e4874d6b4e59333456cf4db425a15b20e9443f247f9e4634042f858818584560
|
data/AUTHENTICATION.md
CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
|
|
114
114
|
To configure your system for this, simply:
|
115
115
|
|
116
116
|
1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
|
117
|
-
2. Authenticate using OAuth 2.0 `$ gcloud auth login`
|
117
|
+
2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
|
118
118
|
3. Write code as if already authenticated.
|
119
119
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Ruby Client for the Workflows V1 API
|
2
2
|
|
3
|
-
|
3
|
+
Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.
|
4
4
|
|
5
5
|
Workflows link series of serverless tasks together in an order you define. Combine the power of Google Cloud's APIs, serverless products like Cloud Functions and Cloud Run, and calls to external APIs to create flexible serverless applications. Workflows requires no infrastructure management and scales seamlessly with demand, including scaling down to zero..
|
6
6
|
|
@@ -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/)
|
@@ -46,7 +46,7 @@ for general usage information.
|
|
46
46
|
## Enabling Logging
|
47
47
|
|
48
48
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
49
|
-
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/
|
49
|
+
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
|
50
50
|
or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
51
51
|
that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
52
52
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
@@ -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
|
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "google/cloud/workflows/v1/workflows/rest"
|
20
|
+
require "google/cloud/workflows/v1/version"
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module Workflows
|
25
|
+
##
|
26
|
+
# To load just the REST part of this package, including all its services, and instantiate a REST client:
|
27
|
+
#
|
28
|
+
# @example
|
29
|
+
#
|
30
|
+
# require "google/cloud/workflows/v1/rest"
|
31
|
+
# client = ::Google::Cloud::Workflows::V1::Workflows::Rest::Client.new
|
32
|
+
#
|
33
|
+
module V1
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -220,13 +220,11 @@ module Google
|
|
220
220
|
# # Call the list_workflows method.
|
221
221
|
# result = client.list_workflows request
|
222
222
|
#
|
223
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
224
|
-
# #
|
225
|
-
#
|
226
|
-
# # methods are also available for managing paging directly.
|
227
|
-
# result.each do |response|
|
223
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
224
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
225
|
+
# result.each do |item|
|
228
226
|
# # Each element is of type ::Google::Cloud::Workflows::V1::Workflow.
|
229
|
-
# p
|
227
|
+
# p item
|
230
228
|
# end
|
231
229
|
#
|
232
230
|
def list_workflows request, options = nil
|
@@ -412,14 +410,14 @@ module Google
|
|
412
410
|
# # Call the create_workflow method.
|
413
411
|
# result = client.create_workflow request
|
414
412
|
#
|
415
|
-
# # The returned object is of type Gapic::Operation. You can use
|
416
|
-
# #
|
417
|
-
# #
|
413
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
414
|
+
# # check the status of an operation, cancel it, or wait for results.
|
415
|
+
# # Here is how to wait for a response.
|
418
416
|
# result.wait_until_done! timeout: 60
|
419
417
|
# if result.response?
|
420
418
|
# p result.response
|
421
419
|
# else
|
422
|
-
# puts "
|
420
|
+
# puts "No response received."
|
423
421
|
# end
|
424
422
|
#
|
425
423
|
def create_workflow request, options = nil
|
@@ -508,14 +506,14 @@ module Google
|
|
508
506
|
# # Call the delete_workflow method.
|
509
507
|
# result = client.delete_workflow request
|
510
508
|
#
|
511
|
-
# # The returned object is of type Gapic::Operation. You can use
|
512
|
-
# #
|
513
|
-
# #
|
509
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
510
|
+
# # check the status of an operation, cancel it, or wait for results.
|
511
|
+
# # Here is how to wait for a response.
|
514
512
|
# result.wait_until_done! timeout: 60
|
515
513
|
# if result.response?
|
516
514
|
# p result.response
|
517
515
|
# else
|
518
|
-
# puts "
|
516
|
+
# puts "No response received."
|
519
517
|
# end
|
520
518
|
#
|
521
519
|
def delete_workflow request, options = nil
|
@@ -608,14 +606,14 @@ module Google
|
|
608
606
|
# # Call the update_workflow method.
|
609
607
|
# result = client.update_workflow request
|
610
608
|
#
|
611
|
-
# # The returned object is of type Gapic::Operation. You can use
|
612
|
-
# #
|
613
|
-
# #
|
609
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
610
|
+
# # check the status of an operation, cancel it, or wait for results.
|
611
|
+
# # Here is how to wait for a response.
|
614
612
|
# result.wait_until_done! timeout: 60
|
615
613
|
# if result.response?
|
616
614
|
# p result.response
|
617
615
|
# else
|
618
|
-
# puts "
|
616
|
+
# puts "No response received."
|
619
617
|
# end
|
620
618
|
#
|
621
619
|
def update_workflow request, options = nil
|
@@ -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
|
@@ -155,13 +158,11 @@ module Google
|
|
155
158
|
# # Call the list_operations method.
|
156
159
|
# result = client.list_operations request
|
157
160
|
#
|
158
|
-
# # The returned object is of type Gapic::PagedEnumerable. You can
|
159
|
-
# #
|
160
|
-
#
|
161
|
-
# # methods are also available for managing paging directly.
|
162
|
-
# result.each do |response|
|
161
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
162
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
163
|
+
# result.each do |item|
|
163
164
|
# # Each element is of type ::Google::Longrunning::Operation.
|
164
|
-
# p
|
165
|
+
# p item
|
165
166
|
# end
|
166
167
|
#
|
167
168
|
def list_operations request, options = nil
|
@@ -250,14 +251,14 @@ module Google
|
|
250
251
|
# # Call the get_operation method.
|
251
252
|
# result = client.get_operation request
|
252
253
|
#
|
253
|
-
# # The returned object is of type Gapic::Operation. You can use
|
254
|
-
# #
|
255
|
-
# #
|
254
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
255
|
+
# # check the status of an operation, cancel it, or wait for results.
|
256
|
+
# # Here is how to wait for a response.
|
256
257
|
# result.wait_until_done! timeout: 60
|
257
258
|
# if result.response?
|
258
259
|
# p result.response
|
259
260
|
# else
|
260
|
-
# puts "
|
261
|
+
# puts "No response received."
|
261
262
|
# end
|
262
263
|
#
|
263
264
|
def get_operation request, options = nil
|
@@ -537,14 +538,14 @@ module Google
|
|
537
538
|
# # Call the wait_operation method.
|
538
539
|
# result = client.wait_operation request
|
539
540
|
#
|
540
|
-
# # The returned object is of type Gapic::Operation. You can use
|
541
|
-
# #
|
542
|
-
# #
|
541
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
542
|
+
# # check the status of an operation, cancel it, or wait for results.
|
543
|
+
# # Here is how to wait for a response.
|
543
544
|
# result.wait_until_done! timeout: 60
|
544
545
|
# if result.response?
|
545
546
|
# p result.response
|
546
547
|
# else
|
547
|
-
# puts "
|
548
|
+
# puts "No response received."
|
548
549
|
# end
|
549
550
|
#
|
550
551
|
def wait_operation request, options = nil
|