google-cloud-tasks-v2 0.2.5 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +8 -8
- data/LICENSE.md +188 -190
- data/README.md +67 -3
- data/lib/google/cloud/tasks/v2.rb +3 -0
- data/lib/google/cloud/tasks/v2/cloud_tasks/client.rb +36 -54
- data/lib/google/cloud/tasks/v2/cloudtasks_services_pb.rb +16 -16
- data/lib/google/cloud/tasks/v2/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +12 -0
- data/proto_docs/google/api/resource.rb +50 -14
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- data/proto_docs/google/type/expr.rb +35 -12
- 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: 0dff57970c590b2929782b5399d0da9aa907cf10129b6fab340c5118882fbe99
|
|
4
|
+
data.tar.gz: 1a4a0d51742babd0242552fb5b94a6f8a39a0f65317b0d69d24e63583211c19b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7e71fe08950383c91ea053ad1f41ff878797463ab7561b0beaa4c8381624b40c27d1143a9cb197969bbb502f5ef29cb58b365060c862ff7825fa4ab523a1997c
|
|
7
|
+
data.tar.gz: 1847a58485685653fc06a6e0a8694d95e103b166d3f65dcc4a0ee9f7a1d909c902dcf1ea23b50f5b626146dbad133a3d873ac2e836f729995bfd092a6335d6b3
|
data/AUTHENTICATION.md
CHANGED
|
@@ -66,11 +66,11 @@ The environment variables that google-cloud-tasks-v2
|
|
|
66
66
|
checks for credentials are configured on the service Credentials class (such as
|
|
67
67
|
{::Google::Cloud::Tasks::V2::CloudTasks::Credentials}):
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
69
|
+
* `TASKS_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
70
|
+
* `TASKS_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/tasks/v2"
|
|
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Tasks::V2::CloudTasks::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/tasks/v2"
|
|
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Tasks::V2::CloudTasks::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/tasks/v2"
|
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 @@ Cloud Tasks is a fully managed service that allows you to manage the execution,
|
|
|
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 Cloud Tasks V2 API. Most users should consider using
|
|
11
|
+
the main client gem,
|
|
12
|
+
[google-cloud-tasks](https://rubygems.org/gems/google-cloud-tasks).
|
|
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/tasks/v2"
|
|
28
34
|
|
|
29
35
|
client = ::Google::Cloud::Tasks::V2::CloudTasks::Client.new
|
|
30
|
-
request =
|
|
36
|
+
request = ::Google::Cloud::Tasks::V2::ListQueuesRequest.new # (request fields as keyword arguments...)
|
|
31
37
|
response = client.list_queues 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-tasks`,
|
|
87
|
+
and lower-level _versioned_ client libraries with names such as
|
|
88
|
+
`google-cloud-tasks-v2`.
|
|
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-tasks`.
|
|
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-tasks-v2`.
|
|
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.
|
|
@@ -61,25 +61,19 @@ module Google
|
|
|
61
61
|
parent_config = while namespace.any?
|
|
62
62
|
parent_name = namespace.join "::"
|
|
63
63
|
parent_const = const_get parent_name
|
|
64
|
-
break parent_const.configure if parent_const
|
|
64
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
|
65
65
|
namespace.pop
|
|
66
66
|
end
|
|
67
67
|
default_config = Client::Configuration.new parent_config
|
|
68
68
|
|
|
69
69
|
default_config.rpcs.list_queues.timeout = 10.0
|
|
70
70
|
default_config.rpcs.list_queues.retry_policy = {
|
|
71
|
-
initial_delay: 0.1,
|
|
72
|
-
max_delay: 10.0,
|
|
73
|
-
multiplier: 1.3,
|
|
74
|
-
retry_codes: [4, 14]
|
|
71
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
75
72
|
}
|
|
76
73
|
|
|
77
74
|
default_config.rpcs.get_queue.timeout = 10.0
|
|
78
75
|
default_config.rpcs.get_queue.retry_policy = {
|
|
79
|
-
initial_delay: 0.1,
|
|
80
|
-
max_delay: 10.0,
|
|
81
|
-
multiplier: 1.3,
|
|
82
|
-
retry_codes: [4, 14]
|
|
76
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
83
77
|
}
|
|
84
78
|
|
|
85
79
|
default_config.rpcs.create_queue.timeout = 10.0
|
|
@@ -88,10 +82,7 @@ module Google
|
|
|
88
82
|
|
|
89
83
|
default_config.rpcs.delete_queue.timeout = 10.0
|
|
90
84
|
default_config.rpcs.delete_queue.retry_policy = {
|
|
91
|
-
initial_delay: 0.1,
|
|
92
|
-
max_delay: 10.0,
|
|
93
|
-
multiplier: 1.3,
|
|
94
|
-
retry_codes: [4, 14]
|
|
85
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
95
86
|
}
|
|
96
87
|
|
|
97
88
|
default_config.rpcs.purge_queue.timeout = 10.0
|
|
@@ -102,46 +93,31 @@ module Google
|
|
|
102
93
|
|
|
103
94
|
default_config.rpcs.get_iam_policy.timeout = 10.0
|
|
104
95
|
default_config.rpcs.get_iam_policy.retry_policy = {
|
|
105
|
-
initial_delay: 0.1,
|
|
106
|
-
max_delay: 10.0,
|
|
107
|
-
multiplier: 1.3,
|
|
108
|
-
retry_codes: [4, 14]
|
|
96
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
109
97
|
}
|
|
110
98
|
|
|
111
99
|
default_config.rpcs.set_iam_policy.timeout = 10.0
|
|
112
100
|
|
|
113
101
|
default_config.rpcs.test_iam_permissions.timeout = 10.0
|
|
114
102
|
default_config.rpcs.test_iam_permissions.retry_policy = {
|
|
115
|
-
initial_delay: 0.1,
|
|
116
|
-
max_delay: 10.0,
|
|
117
|
-
multiplier: 1.3,
|
|
118
|
-
retry_codes: [4, 14]
|
|
103
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
119
104
|
}
|
|
120
105
|
|
|
121
106
|
default_config.rpcs.list_tasks.timeout = 10.0
|
|
122
107
|
default_config.rpcs.list_tasks.retry_policy = {
|
|
123
|
-
initial_delay: 0.1,
|
|
124
|
-
max_delay: 10.0,
|
|
125
|
-
multiplier: 1.3,
|
|
126
|
-
retry_codes: [4, 14]
|
|
108
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
127
109
|
}
|
|
128
110
|
|
|
129
111
|
default_config.rpcs.get_task.timeout = 10.0
|
|
130
112
|
default_config.rpcs.get_task.retry_policy = {
|
|
131
|
-
initial_delay: 0.1,
|
|
132
|
-
max_delay: 10.0,
|
|
133
|
-
multiplier: 1.3,
|
|
134
|
-
retry_codes: [4, 14]
|
|
113
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
135
114
|
}
|
|
136
115
|
|
|
137
116
|
default_config.rpcs.create_task.timeout = 10.0
|
|
138
117
|
|
|
139
118
|
default_config.rpcs.delete_task.timeout = 10.0
|
|
140
119
|
default_config.rpcs.delete_task.retry_policy = {
|
|
141
|
-
initial_delay: 0.1,
|
|
142
|
-
max_delay: 10.0,
|
|
143
|
-
multiplier: 1.3,
|
|
144
|
-
retry_codes: [4, 14]
|
|
120
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
145
121
|
}
|
|
146
122
|
|
|
147
123
|
default_config.rpcs.run_task.timeout = 10.0
|
|
@@ -207,8 +183,14 @@ module Google
|
|
|
207
183
|
|
|
208
184
|
# Create credentials
|
|
209
185
|
credentials = @config.credentials
|
|
210
|
-
|
|
211
|
-
if
|
|
186
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
187
|
+
# but only if the default endpoint does not have a region prefix.
|
|
188
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
|
189
|
+
@config.endpoint == Client.configure.endpoint &&
|
|
190
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
191
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
192
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
193
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
212
194
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
213
195
|
end
|
|
214
196
|
@quota_project_id = @config.quota_project
|
|
@@ -1682,7 +1664,7 @@ module Google
|
|
|
1682
1664
|
config_attr :scope, nil, ::String, ::Array, nil
|
|
1683
1665
|
config_attr :lib_name, nil, ::String, nil
|
|
1684
1666
|
config_attr :lib_version, nil, ::String, nil
|
|
1685
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
|
1667
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
1686
1668
|
config_attr :interceptors, nil, ::Array, nil
|
|
1687
1669
|
config_attr :timeout, nil, ::Numeric, nil
|
|
1688
1670
|
config_attr :metadata, nil, ::Hash, nil
|
|
@@ -1703,7 +1685,7 @@ module Google
|
|
|
1703
1685
|
def rpcs
|
|
1704
1686
|
@rpcs ||= begin
|
|
1705
1687
|
parent_rpcs = nil
|
|
1706
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
|
1688
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
1707
1689
|
Rpcs.new parent_rpcs
|
|
1708
1690
|
end
|
|
1709
1691
|
end
|
|
@@ -1715,7 +1697,7 @@ module Google
|
|
|
1715
1697
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
|
1716
1698
|
# the following configuration fields:
|
|
1717
1699
|
#
|
|
1718
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
|
1700
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
|
1719
1701
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
|
1720
1702
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
|
1721
1703
|
# include the following keys:
|
|
@@ -1809,37 +1791,37 @@ module Google
|
|
|
1809
1791
|
|
|
1810
1792
|
# @private
|
|
1811
1793
|
def initialize parent_rpcs = nil
|
|
1812
|
-
list_queues_config = parent_rpcs
|
|
1794
|
+
list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
|
|
1813
1795
|
@list_queues = ::Gapic::Config::Method.new list_queues_config
|
|
1814
|
-
get_queue_config = parent_rpcs
|
|
1796
|
+
get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
|
|
1815
1797
|
@get_queue = ::Gapic::Config::Method.new get_queue_config
|
|
1816
|
-
create_queue_config = parent_rpcs
|
|
1798
|
+
create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
|
|
1817
1799
|
@create_queue = ::Gapic::Config::Method.new create_queue_config
|
|
1818
|
-
update_queue_config = parent_rpcs
|
|
1800
|
+
update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
|
|
1819
1801
|
@update_queue = ::Gapic::Config::Method.new update_queue_config
|
|
1820
|
-
delete_queue_config = parent_rpcs
|
|
1802
|
+
delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
|
|
1821
1803
|
@delete_queue = ::Gapic::Config::Method.new delete_queue_config
|
|
1822
|
-
purge_queue_config = parent_rpcs
|
|
1804
|
+
purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
|
|
1823
1805
|
@purge_queue = ::Gapic::Config::Method.new purge_queue_config
|
|
1824
|
-
pause_queue_config = parent_rpcs
|
|
1806
|
+
pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
|
|
1825
1807
|
@pause_queue = ::Gapic::Config::Method.new pause_queue_config
|
|
1826
|
-
resume_queue_config = parent_rpcs
|
|
1808
|
+
resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
|
|
1827
1809
|
@resume_queue = ::Gapic::Config::Method.new resume_queue_config
|
|
1828
|
-
get_iam_policy_config = parent_rpcs
|
|
1810
|
+
get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
|
|
1829
1811
|
@get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
|
|
1830
|
-
set_iam_policy_config = parent_rpcs
|
|
1812
|
+
set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
|
|
1831
1813
|
@set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
|
|
1832
|
-
test_iam_permissions_config = parent_rpcs
|
|
1814
|
+
test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
|
|
1833
1815
|
@test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
|
|
1834
|
-
list_tasks_config = parent_rpcs
|
|
1816
|
+
list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
|
|
1835
1817
|
@list_tasks = ::Gapic::Config::Method.new list_tasks_config
|
|
1836
|
-
get_task_config = parent_rpcs
|
|
1818
|
+
get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
|
|
1837
1819
|
@get_task = ::Gapic::Config::Method.new get_task_config
|
|
1838
|
-
create_task_config = parent_rpcs
|
|
1820
|
+
create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
|
|
1839
1821
|
@create_task = ::Gapic::Config::Method.new create_task_config
|
|
1840
|
-
delete_task_config = parent_rpcs
|
|
1822
|
+
delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
|
|
1841
1823
|
@delete_task = ::Gapic::Config::Method.new delete_task_config
|
|
1842
|
-
run_task_config = parent_rpcs
|
|
1824
|
+
run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
|
|
1843
1825
|
@run_task = ::Gapic::Config::Method.new run_task_config
|
|
1844
1826
|
|
|
1845
1827
|
yield self if block_given?
|
|
@@ -38,9 +38,9 @@ module Google
|
|
|
38
38
|
# Lists queues.
|
|
39
39
|
#
|
|
40
40
|
# Queues are returned in lexicographical order.
|
|
41
|
-
rpc :ListQueues, Google::Cloud::Tasks::V2::ListQueuesRequest, Google::Cloud::Tasks::V2::ListQueuesResponse
|
|
41
|
+
rpc :ListQueues, ::Google::Cloud::Tasks::V2::ListQueuesRequest, ::Google::Cloud::Tasks::V2::ListQueuesResponse
|
|
42
42
|
# Gets a queue.
|
|
43
|
-
rpc :GetQueue, Google::Cloud::Tasks::V2::GetQueueRequest, Google::Cloud::Tasks::V2::Queue
|
|
43
|
+
rpc :GetQueue, ::Google::Cloud::Tasks::V2::GetQueueRequest, ::Google::Cloud::Tasks::V2::Queue
|
|
44
44
|
# Creates a queue.
|
|
45
45
|
#
|
|
46
46
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
@@ -53,7 +53,7 @@ module Google
|
|
|
53
53
|
# [Overview of Queue Management and
|
|
54
54
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
|
55
55
|
# this method.
|
|
56
|
-
rpc :CreateQueue, Google::Cloud::Tasks::V2::CreateQueueRequest, Google::Cloud::Tasks::V2::Queue
|
|
56
|
+
rpc :CreateQueue, ::Google::Cloud::Tasks::V2::CreateQueueRequest, ::Google::Cloud::Tasks::V2::Queue
|
|
57
57
|
# Updates a queue.
|
|
58
58
|
#
|
|
59
59
|
# This method creates the queue if it does not exist and updates
|
|
@@ -69,7 +69,7 @@ module Google
|
|
|
69
69
|
# [Overview of Queue Management and
|
|
70
70
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
|
71
71
|
# this method.
|
|
72
|
-
rpc :UpdateQueue, Google::Cloud::Tasks::V2::UpdateQueueRequest, Google::Cloud::Tasks::V2::Queue
|
|
72
|
+
rpc :UpdateQueue, ::Google::Cloud::Tasks::V2::UpdateQueueRequest, ::Google::Cloud::Tasks::V2::Queue
|
|
73
73
|
# Deletes a queue.
|
|
74
74
|
#
|
|
75
75
|
# This command will delete the queue even if it has tasks in it.
|
|
@@ -83,14 +83,14 @@ module Google
|
|
|
83
83
|
# [Overview of Queue Management and
|
|
84
84
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
|
85
85
|
# this method.
|
|
86
|
-
rpc :DeleteQueue, Google::Cloud::Tasks::V2::DeleteQueueRequest, Google::Protobuf::Empty
|
|
86
|
+
rpc :DeleteQueue, ::Google::Cloud::Tasks::V2::DeleteQueueRequest, ::Google::Protobuf::Empty
|
|
87
87
|
# Purges a queue by deleting all of its tasks.
|
|
88
88
|
#
|
|
89
89
|
# All tasks created before this method is called are permanently deleted.
|
|
90
90
|
#
|
|
91
91
|
# Purge operations can take up to one minute to take effect. Tasks
|
|
92
92
|
# might be dispatched before the purge takes effect. A purge is irreversible.
|
|
93
|
-
rpc :PurgeQueue, Google::Cloud::Tasks::V2::PurgeQueueRequest, Google::Cloud::Tasks::V2::Queue
|
|
93
|
+
rpc :PurgeQueue, ::Google::Cloud::Tasks::V2::PurgeQueueRequest, ::Google::Cloud::Tasks::V2::Queue
|
|
94
94
|
# Pauses the queue.
|
|
95
95
|
#
|
|
96
96
|
# If a queue is paused then the system will stop dispatching tasks
|
|
@@ -98,7 +98,7 @@ module Google
|
|
|
98
98
|
# [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can still be added
|
|
99
99
|
# when the queue is paused. A queue is paused if its
|
|
100
100
|
# [state][google.cloud.tasks.v2.Queue.state] is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
|
|
101
|
-
rpc :PauseQueue, Google::Cloud::Tasks::V2::PauseQueueRequest, Google::Cloud::Tasks::V2::Queue
|
|
101
|
+
rpc :PauseQueue, ::Google::Cloud::Tasks::V2::PauseQueueRequest, ::Google::Cloud::Tasks::V2::Queue
|
|
102
102
|
# Resume a queue.
|
|
103
103
|
#
|
|
104
104
|
# This method resumes a queue after it has been
|
|
@@ -112,7 +112,7 @@ module Google
|
|
|
112
112
|
# queues, follow the 500/50/5 pattern described in
|
|
113
113
|
# [Managing Cloud Tasks Scaling
|
|
114
114
|
# Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
|
115
|
-
rpc :ResumeQueue, Google::Cloud::Tasks::V2::ResumeQueueRequest, Google::Cloud::Tasks::V2::Queue
|
|
115
|
+
rpc :ResumeQueue, ::Google::Cloud::Tasks::V2::ResumeQueueRequest, ::Google::Cloud::Tasks::V2::Queue
|
|
116
116
|
# Gets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
|
|
117
117
|
# Returns an empty policy if the resource exists and does not have a policy
|
|
118
118
|
# set.
|
|
@@ -122,7 +122,7 @@ module Google
|
|
|
122
122
|
# resource parent:
|
|
123
123
|
#
|
|
124
124
|
# * `cloudtasks.queues.getIamPolicy`
|
|
125
|
-
rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
|
|
125
|
+
rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
|
|
126
126
|
# Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue]. Replaces any existing
|
|
127
127
|
# policy.
|
|
128
128
|
#
|
|
@@ -134,7 +134,7 @@ module Google
|
|
|
134
134
|
# resource parent:
|
|
135
135
|
#
|
|
136
136
|
# * `cloudtasks.queues.setIamPolicy`
|
|
137
|
-
rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
|
|
137
|
+
rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
|
|
138
138
|
# Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.Queue].
|
|
139
139
|
# If the resource does not exist, this will return an empty set of
|
|
140
140
|
# permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
|
|
@@ -142,7 +142,7 @@ module Google
|
|
|
142
142
|
# Note: This operation is designed to be used for building permission-aware
|
|
143
143
|
# UIs and command-line tools, not for authorization checking. This operation
|
|
144
144
|
# may "fail open" without warning.
|
|
145
|
-
rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
|
|
145
|
+
rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
|
|
146
146
|
# Lists the tasks in a queue.
|
|
147
147
|
#
|
|
148
148
|
# By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is retrieved
|
|
@@ -152,21 +152,21 @@ module Google
|
|
|
152
152
|
#
|
|
153
153
|
# The tasks may be returned in any order. The ordering may change at any
|
|
154
154
|
# time.
|
|
155
|
-
rpc :ListTasks, Google::Cloud::Tasks::V2::ListTasksRequest, Google::Cloud::Tasks::V2::ListTasksResponse
|
|
155
|
+
rpc :ListTasks, ::Google::Cloud::Tasks::V2::ListTasksRequest, ::Google::Cloud::Tasks::V2::ListTasksResponse
|
|
156
156
|
# Gets a task.
|
|
157
|
-
rpc :GetTask, Google::Cloud::Tasks::V2::GetTaskRequest, Google::Cloud::Tasks::V2::Task
|
|
157
|
+
rpc :GetTask, ::Google::Cloud::Tasks::V2::GetTaskRequest, ::Google::Cloud::Tasks::V2::Task
|
|
158
158
|
# Creates a task and adds it to a queue.
|
|
159
159
|
#
|
|
160
160
|
# Tasks cannot be updated after creation; there is no UpdateTask command.
|
|
161
161
|
#
|
|
162
162
|
# * The maximum task size is 100KB.
|
|
163
|
-
rpc :CreateTask, Google::Cloud::Tasks::V2::CreateTaskRequest, Google::Cloud::Tasks::V2::Task
|
|
163
|
+
rpc :CreateTask, ::Google::Cloud::Tasks::V2::CreateTaskRequest, ::Google::Cloud::Tasks::V2::Task
|
|
164
164
|
# Deletes a task.
|
|
165
165
|
#
|
|
166
166
|
# A task can be deleted if it is scheduled or dispatched. A task
|
|
167
167
|
# cannot be deleted if it has executed successfully or permanently
|
|
168
168
|
# failed.
|
|
169
|
-
rpc :DeleteTask, Google::Cloud::Tasks::V2::DeleteTaskRequest, Google::Protobuf::Empty
|
|
169
|
+
rpc :DeleteTask, ::Google::Cloud::Tasks::V2::DeleteTaskRequest, ::Google::Protobuf::Empty
|
|
170
170
|
# Forces a task to run now.
|
|
171
171
|
#
|
|
172
172
|
# When this method is called, Cloud Tasks will dispatch the task, even if
|
|
@@ -191,7 +191,7 @@ module Google
|
|
|
191
191
|
# [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns
|
|
192
192
|
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
|
|
193
193
|
# task that has already succeeded or permanently failed.
|
|
194
|
-
rpc :RunTask, Google::Cloud::Tasks::V2::RunTaskRequest, Google::Cloud::Tasks::V2::Task
|
|
194
|
+
rpc :RunTask, ::Google::Cloud::Tasks::V2::RunTaskRequest, ::Google::Cloud::Tasks::V2::Task
|
|
195
195
|
end
|
|
196
196
|
|
|
197
197
|
Stub = Service.rpc_stub_class
|
|
@@ -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
|
|
@@ -43,12 +43,12 @@ module Google
|
|
|
43
43
|
#
|
|
44
44
|
# The ResourceDescriptor Yaml config will look like:
|
|
45
45
|
#
|
|
46
|
-
#
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
#
|
|
50
|
-
#
|
|
51
|
-
#
|
|
46
|
+
# resources:
|
|
47
|
+
# - 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}"
|
|
52
52
|
#
|
|
53
53
|
# Sometimes, resources have multiple patterns, typically because they can
|
|
54
54
|
# live under multiple parents.
|
|
@@ -183,15 +183,24 @@ module Google
|
|
|
183
183
|
# }
|
|
184
184
|
# @!attribute [rw] plural
|
|
185
185
|
# @return [::String]
|
|
186
|
-
# The plural name used in the resource name, such as
|
|
187
|
-
# the name of 'projects/\\{project}'
|
|
188
|
-
#
|
|
186
|
+
# The plural name used in the resource name and permission names, such as
|
|
187
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
|
188
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
|
189
|
+
# concept of the `plural` field in k8s CRD spec
|
|
189
190
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
|
191
|
+
#
|
|
192
|
+
# Note: The plural form is required even for singleton resources. See
|
|
193
|
+
# https://aip.dev/156
|
|
190
194
|
# @!attribute [rw] singular
|
|
191
195
|
# @return [::String]
|
|
192
196
|
# The same concept of the `singular` field in k8s CRD spec
|
|
193
197
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
|
194
198
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
|
199
|
+
# @!attribute [rw] style
|
|
200
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
|
201
|
+
# Style flag(s) for this resource.
|
|
202
|
+
# These indicate that a resource is expected to conform to a given
|
|
203
|
+
# style. See the specific style flags for additional information.
|
|
195
204
|
class ResourceDescriptor
|
|
196
205
|
include ::Google::Protobuf::MessageExts
|
|
197
206
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -211,6 +220,22 @@ module Google
|
|
|
211
220
|
# that from being necessary once there are multiple patterns.)
|
|
212
221
|
FUTURE_MULTI_PATTERN = 2
|
|
213
222
|
end
|
|
223
|
+
|
|
224
|
+
# A flag representing a specific style that a resource claims to conform to.
|
|
225
|
+
module Style
|
|
226
|
+
# The unspecified value. Do not use.
|
|
227
|
+
STYLE_UNSPECIFIED = 0
|
|
228
|
+
|
|
229
|
+
# This resource is intended to be "declarative-friendly".
|
|
230
|
+
#
|
|
231
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
|
232
|
+
# setting this to true communicates to tools that this resource should
|
|
233
|
+
# adhere to declarative-friendly expectations.
|
|
234
|
+
#
|
|
235
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
|
236
|
+
# additional checks.
|
|
237
|
+
DECLARATIVE_FRIENDLY = 1
|
|
238
|
+
end
|
|
214
239
|
end
|
|
215
240
|
|
|
216
241
|
# Defines a proto annotation that describes a string field that refers to
|
|
@@ -226,6 +251,17 @@ module Google
|
|
|
226
251
|
# type: "pubsub.googleapis.com/Topic"
|
|
227
252
|
# }];
|
|
228
253
|
# }
|
|
254
|
+
#
|
|
255
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
|
256
|
+
# APIs use the special value * in their resource reference.
|
|
257
|
+
#
|
|
258
|
+
# Example:
|
|
259
|
+
#
|
|
260
|
+
# message GetIamPolicyRequest {
|
|
261
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
|
262
|
+
# type: "*"
|
|
263
|
+
# }];
|
|
264
|
+
# }
|
|
229
265
|
# @!attribute [rw] child_type
|
|
230
266
|
# @return [::String]
|
|
231
267
|
# The resource type of a child collection that the annotated field
|
|
@@ -234,11 +270,11 @@ module Google
|
|
|
234
270
|
#
|
|
235
271
|
# Example:
|
|
236
272
|
#
|
|
237
|
-
#
|
|
238
|
-
#
|
|
239
|
-
#
|
|
240
|
-
#
|
|
241
|
-
#
|
|
273
|
+
# message ListLogEntriesRequest {
|
|
274
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
|
275
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
|
276
|
+
# };
|
|
277
|
+
# }
|
|
242
278
|
class ResourceReference
|
|
243
279
|
include ::Google::Protobuf::MessageExts
|
|
244
280
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -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
|
#
|
|
@@ -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()
|
|
@@ -19,30 +19,53 @@
|
|
|
19
19
|
|
|
20
20
|
module Google
|
|
21
21
|
module Type
|
|
22
|
-
# Represents
|
|
22
|
+
# Represents a textual expression in the Common Expression Language (CEL)
|
|
23
|
+
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
|
|
24
|
+
# are documented at https://github.com/google/cel-spec.
|
|
23
25
|
#
|
|
24
|
-
#
|
|
25
|
-
#
|
|
26
|
-
#
|
|
26
|
+
# Example (Comparison):
|
|
27
|
+
#
|
|
28
|
+
# title: "Summary size limit"
|
|
29
|
+
# description: "Determines if a summary is less than 100 chars"
|
|
30
|
+
# expression: "document.summary.size() < 100"
|
|
31
|
+
#
|
|
32
|
+
# Example (Equality):
|
|
33
|
+
#
|
|
34
|
+
# title: "Requestor is owner"
|
|
35
|
+
# description: "Determines if requestor is the document owner"
|
|
36
|
+
# expression: "document.owner == request.auth.claims.email"
|
|
37
|
+
#
|
|
38
|
+
# Example (Logic):
|
|
39
|
+
#
|
|
40
|
+
# title: "Public documents"
|
|
41
|
+
# description: "Determine whether the document should be publicly visible"
|
|
42
|
+
# expression: "document.type != 'private' && document.type != 'internal'"
|
|
43
|
+
#
|
|
44
|
+
# Example (Data Manipulation):
|
|
45
|
+
#
|
|
46
|
+
# title: "Notification string"
|
|
47
|
+
# description: "Create a notification string with a timestamp."
|
|
48
|
+
# expression: "'New message received at ' + string(document.create_time)"
|
|
49
|
+
#
|
|
50
|
+
# The exact variables and functions that may be referenced within an expression
|
|
51
|
+
# are determined by the service that evaluates it. See the service
|
|
52
|
+
# documentation for additional information.
|
|
27
53
|
# @!attribute [rw] expression
|
|
28
54
|
# @return [::String]
|
|
29
|
-
# Textual representation of an expression in
|
|
30
|
-
#
|
|
31
|
-
#
|
|
32
|
-
# The application context of the containing message determines which
|
|
33
|
-
# well-known feature set of CEL is supported.
|
|
55
|
+
# Textual representation of an expression in Common Expression Language
|
|
56
|
+
# syntax.
|
|
34
57
|
# @!attribute [rw] title
|
|
35
58
|
# @return [::String]
|
|
36
|
-
#
|
|
59
|
+
# Optional. Title for the expression, i.e. a short string describing
|
|
37
60
|
# its purpose. This can be used e.g. in UIs which allow to enter the
|
|
38
61
|
# expression.
|
|
39
62
|
# @!attribute [rw] description
|
|
40
63
|
# @return [::String]
|
|
41
|
-
#
|
|
64
|
+
# Optional. Description of the expression. This is a longer text which
|
|
42
65
|
# describes the expression, e.g. when hovered over it in a UI.
|
|
43
66
|
# @!attribute [rw] location
|
|
44
67
|
# @return [::String]
|
|
45
|
-
#
|
|
68
|
+
# Optional. String indicating the location of the expression for error
|
|
46
69
|
# reporting, e.g. a file name and a position in the file.
|
|
47
70
|
class Expr
|
|
48
71
|
include ::Google::Protobuf::MessageExts
|
metadata
CHANGED
|
@@ -1,29 +1,35 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-tasks-v2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2
|
|
4
|
+
version: 0.4.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
|
|
@@ -47,7 +53,7 @@ dependencies:
|
|
|
47
53
|
version: 0.6.10
|
|
48
54
|
- - "<"
|
|
49
55
|
- !ruby/object:Gem::Version
|
|
50
|
-
version:
|
|
56
|
+
version: 2.a
|
|
51
57
|
type: :runtime
|
|
52
58
|
prerelease: false
|
|
53
59
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -57,21 +63,21 @@ dependencies:
|
|
|
57
63
|
version: 0.6.10
|
|
58
64
|
- - "<"
|
|
59
65
|
- !ruby/object:Gem::Version
|
|
60
|
-
version:
|
|
66
|
+
version: 2.a
|
|
61
67
|
- !ruby/object:Gem::Dependency
|
|
62
68
|
name: google-style
|
|
63
69
|
requirement: !ruby/object:Gem::Requirement
|
|
64
70
|
requirements:
|
|
65
71
|
- - "~>"
|
|
66
72
|
- !ruby/object:Gem::Version
|
|
67
|
-
version: 1.
|
|
73
|
+
version: 1.25.1
|
|
68
74
|
type: :development
|
|
69
75
|
prerelease: false
|
|
70
76
|
version_requirements: !ruby/object:Gem::Requirement
|
|
71
77
|
requirements:
|
|
72
78
|
- - "~>"
|
|
73
79
|
- !ruby/object:Gem::Version
|
|
74
|
-
version: 1.
|
|
80
|
+
version: 1.25.1
|
|
75
81
|
- !ruby/object:Gem::Dependency
|
|
76
82
|
name: minitest
|
|
77
83
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -173,7 +179,9 @@ dependencies:
|
|
|
173
179
|
description: Cloud Tasks is a fully managed service that allows you to manage the
|
|
174
180
|
execution, dispatch and delivery of a large number of distributed tasks. You can
|
|
175
181
|
asynchronously perform work outside of a user request. Your tasks can be executed
|
|
176
|
-
on App Engine or any arbitrary HTTP endpoint.
|
|
182
|
+
on App Engine or any arbitrary HTTP endpoint. Note that google-cloud-tasks-v2 is
|
|
183
|
+
a version-specific client library. For most uses, we recommend installing the main
|
|
184
|
+
client library google-cloud-tasks instead. See the readme for more details.
|
|
177
185
|
email: googleapis-packages@google.com
|
|
178
186
|
executables: []
|
|
179
187
|
extensions: []
|
|
@@ -224,14 +232,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
224
232
|
requirements:
|
|
225
233
|
- - ">="
|
|
226
234
|
- !ruby/object:Gem::Version
|
|
227
|
-
version: '2.
|
|
235
|
+
version: '2.5'
|
|
228
236
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
229
237
|
requirements:
|
|
230
238
|
- - ">="
|
|
231
239
|
- !ruby/object:Gem::Version
|
|
232
240
|
version: '0'
|
|
233
241
|
requirements: []
|
|
234
|
-
rubygems_version: 3.
|
|
242
|
+
rubygems_version: 3.2.17
|
|
235
243
|
signing_key:
|
|
236
244
|
specification_version: 4
|
|
237
245
|
summary: API Client library for the Cloud Tasks V2 API
|