google-cloud-workflows-v1beta 0.1.0 → 0.3.2
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/LICENSE.md +188 -190
- data/README.md +67 -3
- data/lib/google/cloud/workflows/v1beta.rb +3 -0
- data/lib/google/cloud/workflows/v1beta/version.rb +1 -1
- data/lib/google/cloud/workflows/v1beta/workflows/client.rb +17 -11
- data/lib/google/cloud/workflows/v1beta/workflows/operations.rb +96 -11
- data/proto_docs/google/api/field_behavior.rb +12 -0
- data/proto_docs/google/longrunning/operations.rb +17 -3
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- metadata +20 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2f7a1570bba30156ffd650f42b0be017eeb0f070138251c6a3019f5c5cc6239a
|
|
4
|
+
data.tar.gz: 8a2c344a13ace99f692732e43c524f40bd44571d2e356e65da9396ea1e6a765b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e9107923dad704ed5afd8587e3fbae08e1266e816b9bc8edfd614a413d0a899bf792638902879740d3700eacb1e3189b804a1c85eca72b64905d5cb3ecd39429
|
|
7
|
+
data.tar.gz: 9d9ca569a79d0b2d22c9ec59c71444e09f54a82022ebe891722903cc744fa0f1c698a90dd1d1c326ed35a1127ffd6425c34eebb7c11038eb08825f43c0289401
|
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/LICENSE.md
CHANGED
|
@@ -1,192 +1,190 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
same "printed page" as the copyright notice for easier
|
|
189
|
-
identification within third-party archives.
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
190
188
|
|
|
191
189
|
Copyright [yyyy] [name of copyright owner]
|
|
192
190
|
|
|
@@ -194,7 +192,7 @@ identification within third-party archives.
|
|
|
194
192
|
you may not use this file except in compliance with the License.
|
|
195
193
|
You may obtain a copy of the License at
|
|
196
194
|
|
|
197
|
-
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
196
|
|
|
199
197
|
Unless required by applicable law or agreed to in writing, software
|
|
200
198
|
distributed under the License is distributed on an "AS IS" BASIS,
|
data/README.md
CHANGED
|
@@ -6,6 +6,12 @@ Workflows link series of serverless tasks together in an order you define. Combi
|
|
|
6
6
|
|
|
7
7
|
https://github.com/googleapis/google-cloud-ruby
|
|
8
8
|
|
|
9
|
+
This gem is a _versioned_ client. It provides basic client classes for a
|
|
10
|
+
specific version of the Workflows V1beta API. Most users should consider using
|
|
11
|
+
the main client gem,
|
|
12
|
+
[google-cloud-workflows](https://rubygems.org/gems/google-cloud-workflows).
|
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
|
14
|
+
|
|
9
15
|
## Installation
|
|
10
16
|
|
|
11
17
|
```
|
|
@@ -27,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
|
27
33
|
require "google/cloud/workflows/v1beta"
|
|
28
34
|
|
|
29
35
|
client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new
|
|
30
|
-
request =
|
|
36
|
+
request = ::Google::Cloud::Workflows::V1beta::ListWorkflowsRequest.new # (request fields as keyword arguments...)
|
|
31
37
|
response = client.list_workflows request
|
|
32
38
|
```
|
|
33
39
|
|
|
@@ -65,11 +71,69 @@ end
|
|
|
65
71
|
|
|
66
72
|
## Supported Ruby Versions
|
|
67
73
|
|
|
68
|
-
This library is supported on Ruby 2.
|
|
74
|
+
This library is supported on Ruby 2.5+.
|
|
69
75
|
|
|
70
76
|
Google provides official support for Ruby versions that are actively supported
|
|
71
77
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
|
72
|
-
in security maintenance, and not end of life. Currently, this means Ruby 2.
|
|
78
|
+
in security maintenance, and not end of life. Currently, this means Ruby 2.5
|
|
73
79
|
and later. Older versions of Ruby _may_ still work, but are unsupported and not
|
|
74
80
|
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
|
75
81
|
about the Ruby support schedule.
|
|
82
|
+
|
|
83
|
+
## Which client should I use?
|
|
84
|
+
|
|
85
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
|
86
|
+
client library with a name such as `google-cloud-workflows`,
|
|
87
|
+
and lower-level _versioned_ client libraries with names such as
|
|
88
|
+
`google-cloud-workflows-v1beta`.
|
|
89
|
+
_In most cases, you should install the main client._
|
|
90
|
+
|
|
91
|
+
### What's the difference between the main client and a versioned client?
|
|
92
|
+
|
|
93
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
|
94
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
|
95
|
+
versions, there might be a separate versioned client for each service version.)
|
|
96
|
+
Most versioned clients are written and maintained by a code generator.
|
|
97
|
+
|
|
98
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
|
99
|
+
interfaces for the service. There will be only one main client for any given
|
|
100
|
+
service, even a service with multiple versions. The main client includes
|
|
101
|
+
factory methods for constructing the client objects we recommend for most
|
|
102
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
|
103
|
+
client; in other cases, they will be handwritten higher-level client objects
|
|
104
|
+
with additional capabilities, convenience methods, or best practices built in.
|
|
105
|
+
Generally, the main client will default to a recommended service version,
|
|
106
|
+
although in some cases you can override this if you need to talk to a specific
|
|
107
|
+
service version.
|
|
108
|
+
|
|
109
|
+
### Why would I want to use the main client?
|
|
110
|
+
|
|
111
|
+
We recommend that most users install the main client gem for a service. You can
|
|
112
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
|
113
|
+
`google-cloud-workflows`.
|
|
114
|
+
The main client is recommended because it will embody the best practices for
|
|
115
|
+
accessing the service, and may also provide more convenient interfaces or
|
|
116
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
|
117
|
+
documentation and samples published by Google will generally demonstrate use of
|
|
118
|
+
the main client.
|
|
119
|
+
|
|
120
|
+
### Why would I want to use a versioned client?
|
|
121
|
+
|
|
122
|
+
You can use a versioned client if you are content with a possibly lower-level
|
|
123
|
+
class interface, you explicitly want to avoid features provided by the main
|
|
124
|
+
client, or you want to access a specific service version not be covered by the
|
|
125
|
+
main client. You can identify versioned client gems because the service version
|
|
126
|
+
is part of the name, e.g. `google-cloud-workflows-v1beta`.
|
|
127
|
+
|
|
128
|
+
### What about the google-apis-<name> clients?
|
|
129
|
+
|
|
130
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
|
131
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
|
132
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
|
133
|
+
not offer the same performance, features, and ease of use provided by more
|
|
134
|
+
modern clients.
|
|
135
|
+
|
|
136
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
|
137
|
+
might need to use one if there is no modern client available for the service.
|
|
138
|
+
However, if a modern client is available, we generally recommend it over the
|
|
139
|
+
older `google-apis-` clients.
|
|
@@ -62,7 +62,7 @@ module Google
|
|
|
62
62
|
parent_config = while namespace.any?
|
|
63
63
|
parent_name = namespace.join "::"
|
|
64
64
|
parent_const = const_get parent_name
|
|
65
|
-
break parent_const.configure if parent_const
|
|
65
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
|
66
66
|
namespace.pop
|
|
67
67
|
end
|
|
68
68
|
default_config = Client::Configuration.new parent_config
|
|
@@ -128,8 +128,14 @@ module Google
|
|
|
128
128
|
|
|
129
129
|
# Create credentials
|
|
130
130
|
credentials = @config.credentials
|
|
131
|
-
|
|
132
|
-
if
|
|
131
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
132
|
+
# 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 &&
|
|
135
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
136
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
137
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
138
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
133
139
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
134
140
|
end
|
|
135
141
|
@quota_project_id = @config.quota_project
|
|
@@ -629,7 +635,7 @@ module Google
|
|
|
629
635
|
config_attr :scope, nil, ::String, ::Array, nil
|
|
630
636
|
config_attr :lib_name, nil, ::String, nil
|
|
631
637
|
config_attr :lib_version, nil, ::String, nil
|
|
632
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
|
638
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
633
639
|
config_attr :interceptors, nil, ::Array, nil
|
|
634
640
|
config_attr :timeout, nil, ::Numeric, nil
|
|
635
641
|
config_attr :metadata, nil, ::Hash, nil
|
|
@@ -650,7 +656,7 @@ module Google
|
|
|
650
656
|
def rpcs
|
|
651
657
|
@rpcs ||= begin
|
|
652
658
|
parent_rpcs = nil
|
|
653
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
|
659
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
654
660
|
Rpcs.new parent_rpcs
|
|
655
661
|
end
|
|
656
662
|
end
|
|
@@ -662,7 +668,7 @@ module Google
|
|
|
662
668
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
|
663
669
|
# the following configuration fields:
|
|
664
670
|
#
|
|
665
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
|
671
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
|
666
672
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
|
667
673
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
|
668
674
|
# include the following keys:
|
|
@@ -701,15 +707,15 @@ module Google
|
|
|
701
707
|
|
|
702
708
|
# @private
|
|
703
709
|
def initialize parent_rpcs = nil
|
|
704
|
-
list_workflows_config = parent_rpcs
|
|
710
|
+
list_workflows_config = parent_rpcs.list_workflows if parent_rpcs.respond_to? :list_workflows
|
|
705
711
|
@list_workflows = ::Gapic::Config::Method.new list_workflows_config
|
|
706
|
-
get_workflow_config = parent_rpcs
|
|
712
|
+
get_workflow_config = parent_rpcs.get_workflow if parent_rpcs.respond_to? :get_workflow
|
|
707
713
|
@get_workflow = ::Gapic::Config::Method.new get_workflow_config
|
|
708
|
-
create_workflow_config = parent_rpcs
|
|
714
|
+
create_workflow_config = parent_rpcs.create_workflow if parent_rpcs.respond_to? :create_workflow
|
|
709
715
|
@create_workflow = ::Gapic::Config::Method.new create_workflow_config
|
|
710
|
-
delete_workflow_config = parent_rpcs
|
|
716
|
+
delete_workflow_config = parent_rpcs.delete_workflow if parent_rpcs.respond_to? :delete_workflow
|
|
711
717
|
@delete_workflow = ::Gapic::Config::Method.new delete_workflow_config
|
|
712
|
-
update_workflow_config = parent_rpcs
|
|
718
|
+
update_workflow_config = parent_rpcs.update_workflow if parent_rpcs.respond_to? :update_workflow
|
|
713
719
|
@update_workflow = ::Gapic::Config::Method.new update_workflow_config
|
|
714
720
|
|
|
715
721
|
yield self if block_given?
|
|
@@ -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
|
|
@@ -103,8 +103,13 @@ module Google
|
|
|
103
103
|
# Lists operations that match the specified filter in the request. If the
|
|
104
104
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
105
105
|
#
|
|
106
|
-
# NOTE: the `name` binding
|
|
107
|
-
# to use different resource name schemes, such as `users/*/operations`.
|
|
106
|
+
# NOTE: the `name` binding allows API services to override the binding
|
|
107
|
+
# to use different resource name schemes, such as `users/*/operations`. To
|
|
108
|
+
# override the binding, API services can add a binding such as
|
|
109
|
+
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
|
110
|
+
# For backwards compatibility, the default name includes the operations
|
|
111
|
+
# collection id, however overriding users must ensure the name binding
|
|
112
|
+
# is the parent resource, without the operations collection id.
|
|
108
113
|
#
|
|
109
114
|
# @overload list_operations(request, options = nil)
|
|
110
115
|
# Pass arguments to `list_operations` via a request object, either of type
|
|
@@ -122,7 +127,7 @@ module Google
|
|
|
122
127
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
123
128
|
#
|
|
124
129
|
# @param name [::String]
|
|
125
|
-
# The name of the operation
|
|
130
|
+
# The name of the operation's parent resource.
|
|
126
131
|
# @param filter [::String]
|
|
127
132
|
# The standard list filter.
|
|
128
133
|
# @param page_size [::Integer]
|
|
@@ -390,6 +395,79 @@ module Google
|
|
|
390
395
|
raise ::Google::Cloud::Error.from_error(e)
|
|
391
396
|
end
|
|
392
397
|
|
|
398
|
+
##
|
|
399
|
+
# Waits until the specified long-running operation is done or reaches at most
|
|
400
|
+
# a specified timeout, returning the latest state. If the operation is
|
|
401
|
+
# already done, the latest state is immediately returned. If the timeout
|
|
402
|
+
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
|
403
|
+
# timeout is used. If the server does not support this method, it returns
|
|
404
|
+
# `google.rpc.Code.UNIMPLEMENTED`.
|
|
405
|
+
# Note that this method is on a best-effort basis. It may return the latest
|
|
406
|
+
# state before the specified timeout (including immediately), meaning even an
|
|
407
|
+
# immediate response is no guarantee that the operation is done.
|
|
408
|
+
#
|
|
409
|
+
# @overload wait_operation(request, options = nil)
|
|
410
|
+
# Pass arguments to `wait_operation` via a request object, either of type
|
|
411
|
+
# {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
|
|
412
|
+
#
|
|
413
|
+
# @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
|
|
414
|
+
# A request object representing the call parameters. Required. To specify no
|
|
415
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
416
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
417
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
418
|
+
#
|
|
419
|
+
# @overload wait_operation(name: nil, timeout: nil)
|
|
420
|
+
# Pass arguments to `wait_operation` via keyword arguments. Note that at
|
|
421
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
422
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
423
|
+
#
|
|
424
|
+
# @param name [::String]
|
|
425
|
+
# The name of the operation resource to wait on.
|
|
426
|
+
# @param timeout [::Google::Protobuf::Duration, ::Hash]
|
|
427
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
|
428
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
|
429
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
|
430
|
+
#
|
|
431
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
432
|
+
# @yieldparam response [::Gapic::Operation]
|
|
433
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
434
|
+
#
|
|
435
|
+
# @return [::Gapic::Operation]
|
|
436
|
+
#
|
|
437
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
438
|
+
#
|
|
439
|
+
def wait_operation request, options = nil
|
|
440
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
441
|
+
|
|
442
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
|
|
443
|
+
|
|
444
|
+
# Converts hash and nil to an options object
|
|
445
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
446
|
+
|
|
447
|
+
# Customize the options with defaults
|
|
448
|
+
metadata = @config.rpcs.wait_operation.metadata.to_h
|
|
449
|
+
|
|
450
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
451
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
452
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
453
|
+
gapic_version: ::Google::Cloud::Workflows::V1beta::VERSION
|
|
454
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
455
|
+
|
|
456
|
+
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
|
457
|
+
metadata: metadata,
|
|
458
|
+
retry_policy: @config.rpcs.wait_operation.retry_policy
|
|
459
|
+
options.apply_defaults metadata: @config.metadata,
|
|
460
|
+
retry_policy: @config.retry_policy
|
|
461
|
+
|
|
462
|
+
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
|
463
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
464
|
+
yield response, operation if block_given?
|
|
465
|
+
return response
|
|
466
|
+
end
|
|
467
|
+
rescue ::GRPC::BadStatus => e
|
|
468
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
469
|
+
end
|
|
470
|
+
|
|
393
471
|
##
|
|
394
472
|
# Configuration class for the Operations API.
|
|
395
473
|
#
|
|
@@ -482,7 +560,7 @@ module Google
|
|
|
482
560
|
config_attr :scope, nil, ::String, ::Array, nil
|
|
483
561
|
config_attr :lib_name, nil, ::String, nil
|
|
484
562
|
config_attr :lib_version, nil, ::String, nil
|
|
485
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
|
563
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
486
564
|
config_attr :interceptors, nil, ::Array, nil
|
|
487
565
|
config_attr :timeout, nil, ::Numeric, nil
|
|
488
566
|
config_attr :metadata, nil, ::Hash, nil
|
|
@@ -503,7 +581,7 @@ module Google
|
|
|
503
581
|
def rpcs
|
|
504
582
|
@rpcs ||= begin
|
|
505
583
|
parent_rpcs = nil
|
|
506
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
|
584
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
507
585
|
Rpcs.new parent_rpcs
|
|
508
586
|
end
|
|
509
587
|
end
|
|
@@ -515,7 +593,7 @@ module Google
|
|
|
515
593
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
|
516
594
|
# the following configuration fields:
|
|
517
595
|
#
|
|
518
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
|
596
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
|
519
597
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
|
520
598
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
|
521
599
|
# include the following keys:
|
|
@@ -546,17 +624,24 @@ module Google
|
|
|
546
624
|
# @return [::Gapic::Config::Method]
|
|
547
625
|
#
|
|
548
626
|
attr_reader :cancel_operation
|
|
627
|
+
##
|
|
628
|
+
# RPC-specific configuration for `wait_operation`
|
|
629
|
+
# @return [::Gapic::Config::Method]
|
|
630
|
+
#
|
|
631
|
+
attr_reader :wait_operation
|
|
549
632
|
|
|
550
633
|
# @private
|
|
551
634
|
def initialize parent_rpcs = nil
|
|
552
|
-
list_operations_config = parent_rpcs
|
|
635
|
+
list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
|
|
553
636
|
@list_operations = ::Gapic::Config::Method.new list_operations_config
|
|
554
|
-
get_operation_config = parent_rpcs
|
|
637
|
+
get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
|
|
555
638
|
@get_operation = ::Gapic::Config::Method.new get_operation_config
|
|
556
|
-
delete_operation_config = parent_rpcs
|
|
639
|
+
delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
|
|
557
640
|
@delete_operation = ::Gapic::Config::Method.new delete_operation_config
|
|
558
|
-
cancel_operation_config = parent_rpcs
|
|
641
|
+
cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
|
|
559
642
|
@cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
|
|
643
|
+
wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
|
|
644
|
+
@wait_operation = ::Gapic::Config::Method.new wait_operation_config
|
|
560
645
|
|
|
561
646
|
yield self if block_given?
|
|
562
647
|
end
|
|
@@ -54,6 +54,18 @@ module Google
|
|
|
54
54
|
# This indicates that the field may be set once in a request to create a
|
|
55
55
|
# resource, but may not be changed thereafter.
|
|
56
56
|
IMMUTABLE = 5
|
|
57
|
+
|
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
|
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
|
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
|
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
|
|
57
69
|
end
|
|
58
70
|
end
|
|
59
71
|
end
|
|
@@ -25,7 +25,7 @@ module Google
|
|
|
25
25
|
# @return [::String]
|
|
26
26
|
# The server-assigned name, which is only unique within the same service that
|
|
27
27
|
# originally returns it. If you use the default HTTP mapping, the
|
|
28
|
-
# `name` should
|
|
28
|
+
# `name` should be a resource name ending with `operations/{unique_id}`.
|
|
29
29
|
# @!attribute [rw] metadata
|
|
30
30
|
# @return [::Google::Protobuf::Any]
|
|
31
31
|
# Service-specific metadata associated with the operation. It typically
|
|
@@ -35,7 +35,7 @@ module Google
|
|
|
35
35
|
# @!attribute [rw] done
|
|
36
36
|
# @return [::Boolean]
|
|
37
37
|
# If the value is `false`, it means the operation is still in progress.
|
|
38
|
-
# If true
|
|
38
|
+
# If `true`, the operation is completed, and either `error` or `response` is
|
|
39
39
|
# available.
|
|
40
40
|
# @!attribute [rw] error
|
|
41
41
|
# @return [::Google::Rpc::Status]
|
|
@@ -67,7 +67,7 @@ module Google
|
|
|
67
67
|
# The request message for Operations.ListOperations.
|
|
68
68
|
# @!attribute [rw] name
|
|
69
69
|
# @return [::String]
|
|
70
|
-
# The name of the operation
|
|
70
|
+
# The name of the operation's parent resource.
|
|
71
71
|
# @!attribute [rw] filter
|
|
72
72
|
# @return [::String]
|
|
73
73
|
# The standard list filter.
|
|
@@ -112,6 +112,20 @@ module Google
|
|
|
112
112
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
113
113
|
end
|
|
114
114
|
|
|
115
|
+
# The request message for Operations.WaitOperation.
|
|
116
|
+
# @!attribute [rw] name
|
|
117
|
+
# @return [::String]
|
|
118
|
+
# The name of the operation resource to wait on.
|
|
119
|
+
# @!attribute [rw] timeout
|
|
120
|
+
# @return [::Google::Protobuf::Duration]
|
|
121
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
|
122
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
|
123
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
|
124
|
+
class WaitOperationRequest
|
|
125
|
+
include ::Google::Protobuf::MessageExts
|
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
127
|
+
end
|
|
128
|
+
|
|
115
129
|
# A message representing the message types used by a long-running operation.
|
|
116
130
|
#
|
|
117
131
|
# Example:
|
|
@@ -57,10 +57,13 @@ module Google
|
|
|
57
57
|
# Example 4: Pack and unpack a message in Go
|
|
58
58
|
#
|
|
59
59
|
# foo := &pb.Foo{...}
|
|
60
|
-
# any, err :=
|
|
60
|
+
# any, err := anypb.New(foo)
|
|
61
|
+
# if err != nil {
|
|
62
|
+
# ...
|
|
63
|
+
# }
|
|
61
64
|
# ...
|
|
62
65
|
# foo := &pb.Foo{}
|
|
63
|
-
# if err :=
|
|
66
|
+
# if err := any.UnmarshalTo(foo); err != nil {
|
|
64
67
|
# ...
|
|
65
68
|
# }
|
|
66
69
|
#
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2021 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
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Protobuf
|
|
22
|
+
# A Duration represents a signed, fixed-length span of time represented
|
|
23
|
+
# as a count of seconds and fractions of seconds at nanosecond
|
|
24
|
+
# resolution. It is independent of any calendar and concepts like "day"
|
|
25
|
+
# or "month". It is related to Timestamp in that the difference between
|
|
26
|
+
# two Timestamp values is a Duration and it can be added or subtracted
|
|
27
|
+
# from a Timestamp. Range is approximately +-10,000 years.
|
|
28
|
+
#
|
|
29
|
+
# # Examples
|
|
30
|
+
#
|
|
31
|
+
# Example 1: Compute Duration from two Timestamps in pseudo code.
|
|
32
|
+
#
|
|
33
|
+
# Timestamp start = ...;
|
|
34
|
+
# Timestamp end = ...;
|
|
35
|
+
# Duration duration = ...;
|
|
36
|
+
#
|
|
37
|
+
# duration.seconds = end.seconds - start.seconds;
|
|
38
|
+
# duration.nanos = end.nanos - start.nanos;
|
|
39
|
+
#
|
|
40
|
+
# if (duration.seconds < 0 && duration.nanos > 0) {
|
|
41
|
+
# duration.seconds += 1;
|
|
42
|
+
# duration.nanos -= 1000000000;
|
|
43
|
+
# } else if (duration.seconds > 0 && duration.nanos < 0) {
|
|
44
|
+
# duration.seconds -= 1;
|
|
45
|
+
# duration.nanos += 1000000000;
|
|
46
|
+
# }
|
|
47
|
+
#
|
|
48
|
+
# Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
|
49
|
+
#
|
|
50
|
+
# Timestamp start = ...;
|
|
51
|
+
# Duration duration = ...;
|
|
52
|
+
# Timestamp end = ...;
|
|
53
|
+
#
|
|
54
|
+
# end.seconds = start.seconds + duration.seconds;
|
|
55
|
+
# end.nanos = start.nanos + duration.nanos;
|
|
56
|
+
#
|
|
57
|
+
# if (end.nanos < 0) {
|
|
58
|
+
# end.seconds -= 1;
|
|
59
|
+
# end.nanos += 1000000000;
|
|
60
|
+
# } else if (end.nanos >= 1000000000) {
|
|
61
|
+
# end.seconds += 1;
|
|
62
|
+
# end.nanos -= 1000000000;
|
|
63
|
+
# }
|
|
64
|
+
#
|
|
65
|
+
# Example 3: Compute Duration from datetime.timedelta in Python.
|
|
66
|
+
#
|
|
67
|
+
# td = datetime.timedelta(days=3, minutes=10)
|
|
68
|
+
# duration = Duration()
|
|
69
|
+
# duration.FromTimedelta(td)
|
|
70
|
+
#
|
|
71
|
+
# # JSON Mapping
|
|
72
|
+
#
|
|
73
|
+
# In JSON format, the Duration type is encoded as a string rather than an
|
|
74
|
+
# object, where the string ends in the suffix "s" (indicating seconds) and
|
|
75
|
+
# is preceded by the number of seconds, with nanoseconds expressed as
|
|
76
|
+
# fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
|
77
|
+
# encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
|
78
|
+
# be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
|
79
|
+
# microsecond should be expressed in JSON format as "3.000001s".
|
|
80
|
+
# @!attribute [rw] seconds
|
|
81
|
+
# @return [::Integer]
|
|
82
|
+
# Signed seconds of the span of time. Must be from -315,576,000,000
|
|
83
|
+
# to +315,576,000,000 inclusive. Note: these bounds are computed from:
|
|
84
|
+
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
|
|
85
|
+
# @!attribute [rw] nanos
|
|
86
|
+
# @return [::Integer]
|
|
87
|
+
# Signed fractions of a second at nanosecond resolution of the span
|
|
88
|
+
# of time. Durations less than one second are represented with a 0
|
|
89
|
+
# `seconds` field and a positive or negative `nanos` field. For durations
|
|
90
|
+
# of one second or more, a non-zero value for the `nanos` field must be
|
|
91
|
+
# of the same sign as the `seconds` field. Must be from -999,999,999
|
|
92
|
+
# to +999,999,999 inclusive.
|
|
93
|
+
class Duration
|
|
94
|
+
include ::Google::Protobuf::MessageExts
|
|
95
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
@@ -70,7 +70,16 @@ module Google
|
|
|
70
70
|
# .setNanos((int) ((millis % 1000) * 1000000)).build();
|
|
71
71
|
#
|
|
72
72
|
#
|
|
73
|
-
# Example 5: Compute Timestamp from
|
|
73
|
+
# Example 5: Compute Timestamp from Java `Instant.now()`.
|
|
74
|
+
#
|
|
75
|
+
# Instant now = Instant.now();
|
|
76
|
+
#
|
|
77
|
+
# Timestamp timestamp =
|
|
78
|
+
# Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
|
79
|
+
# .setNanos(now.getNano()).build();
|
|
80
|
+
#
|
|
81
|
+
#
|
|
82
|
+
# Example 6: Compute Timestamp from current time in Python.
|
|
74
83
|
#
|
|
75
84
|
# timestamp = Timestamp()
|
|
76
85
|
# timestamp.GetCurrentTime()
|
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.
|
|
4
|
+
version: 0.3.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2021-07-12 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.5'
|
|
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.5'
|
|
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
|
|
@@ -44,14 +50,14 @@ dependencies:
|
|
|
44
50
|
requirements:
|
|
45
51
|
- - "~>"
|
|
46
52
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: 1.
|
|
53
|
+
version: 1.25.1
|
|
48
54
|
type: :development
|
|
49
55
|
prerelease: false
|
|
50
56
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
57
|
requirements:
|
|
52
58
|
- - "~>"
|
|
53
59
|
- !ruby/object:Gem::Version
|
|
54
|
-
version: 1.
|
|
60
|
+
version: 1.25.1
|
|
55
61
|
- !ruby/object:Gem::Dependency
|
|
56
62
|
name: minitest
|
|
57
63
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -154,7 +160,9 @@ description: Workflows link series of serverless tasks together in an order you
|
|
|
154
160
|
Combine the power of Google Cloud's APIs, serverless products like Cloud Functions
|
|
155
161
|
and Cloud Run, and calls to external APIs to create flexible serverless applications.
|
|
156
162
|
Workflows requires no infrastructure management and scales seamlessly with demand,
|
|
157
|
-
including scaling down to zero..
|
|
163
|
+
including scaling down to zero.. Note that google-cloud-workflows-v1beta is a version-specific
|
|
164
|
+
client library. For most uses, we recommend installing the main client library google-cloud-workflows
|
|
165
|
+
instead. See the readme for more details.
|
|
158
166
|
email: googleapis-packages@google.com
|
|
159
167
|
executables: []
|
|
160
168
|
extensions: []
|
|
@@ -180,6 +188,7 @@ files:
|
|
|
180
188
|
- proto_docs/google/cloud/workflows/v1beta/workflows.rb
|
|
181
189
|
- proto_docs/google/longrunning/operations.rb
|
|
182
190
|
- proto_docs/google/protobuf/any.rb
|
|
191
|
+
- proto_docs/google/protobuf/duration.rb
|
|
183
192
|
- proto_docs/google/protobuf/empty.rb
|
|
184
193
|
- proto_docs/google/protobuf/field_mask.rb
|
|
185
194
|
- proto_docs/google/protobuf/timestamp.rb
|
|
@@ -196,14 +205,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
196
205
|
requirements:
|
|
197
206
|
- - ">="
|
|
198
207
|
- !ruby/object:Gem::Version
|
|
199
|
-
version: '2.
|
|
208
|
+
version: '2.5'
|
|
200
209
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
201
210
|
requirements:
|
|
202
211
|
- - ">="
|
|
203
212
|
- !ruby/object:Gem::Version
|
|
204
213
|
version: '0'
|
|
205
214
|
requirements: []
|
|
206
|
-
rubygems_version: 3.
|
|
215
|
+
rubygems_version: 3.2.17
|
|
207
216
|
signing_key:
|
|
208
217
|
specification_version: 4
|
|
209
218
|
summary: API Client library for the Workflows V1beta API
|