google-cloud-tasks-v2beta3 0.10.1 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/tasks/v2beta3/bindings_override.rb +102 -0
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks/client.rb +265 -109
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb +523 -114
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/service_stub.rb +61 -0
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks/rest.rb +1 -0
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +5 -1
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb +49 -30
- data/lib/google/cloud/tasks/v2beta3/queue_pb.rb +1 -1
- data/lib/google/cloud/tasks/v2beta3/rest.rb +1 -0
- data/lib/google/cloud/tasks/v2beta3/target_pb.rb +9 -1
- data/lib/google/cloud/tasks/v2beta3/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +14 -0
- data/proto_docs/google/api/httpbody.rb +80 -0
- data/proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb +155 -99
- data/proto_docs/google/cloud/tasks/v2beta3/queue.rb +5 -2
- data/proto_docs/google/cloud/tasks/v2beta3/target.rb +199 -0
- data/proto_docs/google/cloud/tasks/v2beta3/task.rb +1 -1
- data/proto_docs/google/iam/v1/policy.rb +8 -4
- metadata +27 -5
|
@@ -49,6 +49,202 @@ module Google
|
|
|
49
49
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
50
50
|
end
|
|
51
51
|
|
|
52
|
+
# PathOverride.
|
|
53
|
+
#
|
|
54
|
+
# Path message defines path override for HTTP targets.
|
|
55
|
+
# @!attribute [rw] path
|
|
56
|
+
# @return [::String]
|
|
57
|
+
# The URI path (e.g., /users/1234). Default is an empty string.
|
|
58
|
+
class PathOverride
|
|
59
|
+
include ::Google::Protobuf::MessageExts
|
|
60
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# QueryOverride.
|
|
64
|
+
#
|
|
65
|
+
# Query message defines query override for HTTP targets.
|
|
66
|
+
# @!attribute [rw] query_params
|
|
67
|
+
# @return [::String]
|
|
68
|
+
# The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty
|
|
69
|
+
# string.
|
|
70
|
+
class QueryOverride
|
|
71
|
+
include ::Google::Protobuf::MessageExts
|
|
72
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# URI Override.
|
|
76
|
+
#
|
|
77
|
+
# When specified, all the HTTP tasks inside the queue will be partially or
|
|
78
|
+
# fully overridden depending on the configured values.
|
|
79
|
+
# @!attribute [rw] scheme
|
|
80
|
+
# @return [::Google::Cloud::Tasks::V2beta3::UriOverride::Scheme]
|
|
81
|
+
# Scheme override.
|
|
82
|
+
#
|
|
83
|
+
# When specified, the task URI scheme is replaced by the provided value (HTTP
|
|
84
|
+
# or HTTPS).
|
|
85
|
+
# @!attribute [rw] host
|
|
86
|
+
# @return [::String]
|
|
87
|
+
# Host override.
|
|
88
|
+
#
|
|
89
|
+
# When specified, replaces the host part of the task URL. For example,
|
|
90
|
+
# if the task URL is "https://www.google.com," and host value is set to
|
|
91
|
+
# "example.net", the overridden URI will be changed to "https://example.net."
|
|
92
|
+
# Host value cannot be an empty string (INVALID_ARGUMENT).
|
|
93
|
+
# @!attribute [rw] port
|
|
94
|
+
# @return [::Integer]
|
|
95
|
+
# Port override.
|
|
96
|
+
#
|
|
97
|
+
# When specified, replaces the port part of the task URI. For instance,
|
|
98
|
+
# for a URI http://www.google.com/foo and port=123, the overridden URI
|
|
99
|
+
# becomes http://www.google.com:123/foo. Note that the port value must be a
|
|
100
|
+
# positive integer. Setting the port to 0 (Zero) clears the URI port.
|
|
101
|
+
# @!attribute [rw] path_override
|
|
102
|
+
# @return [::Google::Cloud::Tasks::V2beta3::PathOverride]
|
|
103
|
+
# URI path.
|
|
104
|
+
#
|
|
105
|
+
# When specified, replaces the existing path of the task URL. Setting the
|
|
106
|
+
# path value to an empty string clears the URI path segment.
|
|
107
|
+
# @!attribute [rw] query_override
|
|
108
|
+
# @return [::Google::Cloud::Tasks::V2beta3::QueryOverride]
|
|
109
|
+
# URI Query.
|
|
110
|
+
#
|
|
111
|
+
# When specified, replaces the query part of the task URI. Setting the
|
|
112
|
+
# query value to an empty string clears the URI query segment.
|
|
113
|
+
# @!attribute [rw] uri_override_enforce_mode
|
|
114
|
+
# @return [::Google::Cloud::Tasks::V2beta3::UriOverride::UriOverrideEnforceMode]
|
|
115
|
+
# URI Override Enforce Mode
|
|
116
|
+
#
|
|
117
|
+
# When specified, determines the Target UriOverride mode. If not specified,
|
|
118
|
+
# it defaults to ALWAYS.
|
|
119
|
+
class UriOverride
|
|
120
|
+
include ::Google::Protobuf::MessageExts
|
|
121
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
122
|
+
|
|
123
|
+
# The Scheme for an HTTP request. By default, it is HTTPS.
|
|
124
|
+
module Scheme
|
|
125
|
+
# Scheme unspecified. Defaults to HTTPS.
|
|
126
|
+
SCHEME_UNSPECIFIED = 0
|
|
127
|
+
|
|
128
|
+
# Convert the scheme to HTTP, e.g., https://www.google.ca will change to
|
|
129
|
+
# http://www.google.ca.
|
|
130
|
+
HTTP = 1
|
|
131
|
+
|
|
132
|
+
# Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
|
|
133
|
+
# https://www.google.ca.
|
|
134
|
+
HTTPS = 2
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# UriOverrideEnforceMode mode is to define enforcing mode for the override
|
|
138
|
+
# modes.
|
|
139
|
+
module UriOverrideEnforceMode
|
|
140
|
+
# OverrideMode Unspecified. Defaults to ALWAYS.
|
|
141
|
+
URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED = 0
|
|
142
|
+
|
|
143
|
+
# In the IF_NOT_EXISTS mode, queue-level configuration is only
|
|
144
|
+
# applied where task-level configuration does not exist.
|
|
145
|
+
IF_NOT_EXISTS = 1
|
|
146
|
+
|
|
147
|
+
# In the ALWAYS mode, queue-level configuration overrides all
|
|
148
|
+
# task-level configuration
|
|
149
|
+
ALWAYS = 2
|
|
150
|
+
end
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# HTTP target.
|
|
154
|
+
#
|
|
155
|
+
# When specified as a [Queue][target_type], all the tasks with [HttpRequest]
|
|
156
|
+
# will be overridden according to the target.
|
|
157
|
+
# @!attribute [rw] uri_override
|
|
158
|
+
# @return [::Google::Cloud::Tasks::V2beta3::UriOverride]
|
|
159
|
+
# URI override.
|
|
160
|
+
#
|
|
161
|
+
# When specified, overrides the execution URI for all the tasks in the queue.
|
|
162
|
+
# @!attribute [rw] http_method
|
|
163
|
+
# @return [::Google::Cloud::Tasks::V2beta3::HttpMethod]
|
|
164
|
+
# The HTTP method to use for the request.
|
|
165
|
+
#
|
|
166
|
+
# When specified, it overrides
|
|
167
|
+
# {::Google::Cloud::Tasks::V2beta3::HttpTarget#http_method HttpRequest} for the
|
|
168
|
+
# task. Note that if the value is set to [HttpMethod][GET] the
|
|
169
|
+
# [HttpRequest][body] of the task will be ignored at execution time.
|
|
170
|
+
# @!attribute [rw] header_overrides
|
|
171
|
+
# @return [::Array<::Google::Cloud::Tasks::V2beta3::HttpTarget::HeaderOverride>]
|
|
172
|
+
# HTTP target headers.
|
|
173
|
+
#
|
|
174
|
+
# This map contains the header field names and values.
|
|
175
|
+
# Headers will be set when running the
|
|
176
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#create_task CreateTask} and/or
|
|
177
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#buffer_task BufferTask}.
|
|
178
|
+
#
|
|
179
|
+
# These headers represent a subset of the headers that will be configured for
|
|
180
|
+
# the task's HTTP request. Some HTTP request headers will be ignored or
|
|
181
|
+
# replaced.
|
|
182
|
+
#
|
|
183
|
+
# A partial list of headers that will be ignored or replaced is:
|
|
184
|
+
# * Several predefined headers, prefixed with "X-CloudTasks-", can
|
|
185
|
+
# be used to define properties of the task.
|
|
186
|
+
# * Host: This will be computed by Cloud Tasks and derived from
|
|
187
|
+
# [HttpRequest.url][google.cloud.tasks.v2beta3.Target.HttpRequest.url].
|
|
188
|
+
# * Content-Length: This will be computed by Cloud Tasks.
|
|
189
|
+
#
|
|
190
|
+
# `Content-Type` won't be set by Cloud Tasks. You can explicitly set
|
|
191
|
+
# `Content-Type` to a media type when the
|
|
192
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#create_task task is created}.
|
|
193
|
+
# For example,`Content-Type` can be set to `"application/octet-stream"` or
|
|
194
|
+
# `"application/json"`. The default value is set to `"application/json"`.
|
|
195
|
+
#
|
|
196
|
+
# * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
|
|
197
|
+
#
|
|
198
|
+
# Headers which can have multiple values (according to RFC2616) can be
|
|
199
|
+
# specified using comma-separated values.
|
|
200
|
+
#
|
|
201
|
+
# The size of the headers must be less than 80KB.
|
|
202
|
+
# Queue-level headers to override headers of all the tasks in the queue.
|
|
203
|
+
# @!attribute [rw] oauth_token
|
|
204
|
+
# @return [::Google::Cloud::Tasks::V2beta3::OAuthToken]
|
|
205
|
+
# If specified, an
|
|
206
|
+
# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
|
|
207
|
+
# will be generated and attached as the `Authorization` header in the HTTP
|
|
208
|
+
# request.
|
|
209
|
+
#
|
|
210
|
+
# This type of authorization should generally only be used when calling
|
|
211
|
+
# Google APIs hosted on *.googleapis.com.
|
|
212
|
+
# @!attribute [rw] oidc_token
|
|
213
|
+
# @return [::Google::Cloud::Tasks::V2beta3::OidcToken]
|
|
214
|
+
# If specified, an
|
|
215
|
+
# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
|
|
216
|
+
# token will be generated and attached as an `Authorization` header in the
|
|
217
|
+
# HTTP request.
|
|
218
|
+
#
|
|
219
|
+
# This type of authorization can be used for many scenarios, including
|
|
220
|
+
# calling Cloud Run, or endpoints where you intend to validate the token
|
|
221
|
+
# yourself.
|
|
222
|
+
class HttpTarget
|
|
223
|
+
include ::Google::Protobuf::MessageExts
|
|
224
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
225
|
+
|
|
226
|
+
# Defines a header message. A header can have a key and a value.
|
|
227
|
+
# @!attribute [rw] key
|
|
228
|
+
# @return [::String]
|
|
229
|
+
# The Key of the header.
|
|
230
|
+
# @!attribute [rw] value
|
|
231
|
+
# @return [::String]
|
|
232
|
+
# The Value of the header.
|
|
233
|
+
class Header
|
|
234
|
+
include ::Google::Protobuf::MessageExts
|
|
235
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
# Wraps the Header object.
|
|
239
|
+
# @!attribute [rw] header
|
|
240
|
+
# @return [::Google::Cloud::Tasks::V2beta3::HttpTarget::Header]
|
|
241
|
+
# header embodying a key and a value.
|
|
242
|
+
class HeaderOverride
|
|
243
|
+
include ::Google::Protobuf::MessageExts
|
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
245
|
+
end
|
|
246
|
+
end
|
|
247
|
+
|
|
52
248
|
# HTTP request.
|
|
53
249
|
#
|
|
54
250
|
# The task will be pushed to the worker as an HTTP request. If the worker
|
|
@@ -107,6 +303,9 @@ module Google
|
|
|
107
303
|
#
|
|
108
304
|
# A partial list of headers that will be ignored or replaced is:
|
|
109
305
|
#
|
|
306
|
+
# * Any header that is prefixed with "X-CloudTasks-" will be treated
|
|
307
|
+
# as service header. Service headers define properties of the task and are
|
|
308
|
+
# predefined in CloudTask.
|
|
110
309
|
# * Host: This will be computed by Cloud Tasks and derived from
|
|
111
310
|
# {::Google::Cloud::Tasks::V2beta3::HttpRequest#url HttpRequest.url}.
|
|
112
311
|
# * Content-Length: This will be computed by Cloud Tasks.
|
|
@@ -39,7 +39,7 @@ module Google
|
|
|
39
39
|
# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
|
|
40
40
|
# * `LOCATION_ID` is the canonical ID for the task's location.
|
|
41
41
|
# The list of available locations can be obtained by calling
|
|
42
|
-
#
|
|
42
|
+
# `::Google::Cloud::Location::Locations::Client#list_locations`.
|
|
43
43
|
# For more information, see https://cloud.google.com/about/locations/.
|
|
44
44
|
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
|
|
45
45
|
# hyphens (-). The maximum length is 100 characters.
|
|
@@ -40,6 +40,7 @@ module Google
|
|
|
40
40
|
#
|
|
41
41
|
# **JSON example:**
|
|
42
42
|
#
|
|
43
|
+
# ```
|
|
43
44
|
# {
|
|
44
45
|
# "bindings": [
|
|
45
46
|
# {
|
|
@@ -67,9 +68,11 @@ module Google
|
|
|
67
68
|
# "etag": "BwWWja0YfJA=",
|
|
68
69
|
# "version": 3
|
|
69
70
|
# }
|
|
71
|
+
# ```
|
|
70
72
|
#
|
|
71
73
|
# **YAML example:**
|
|
72
74
|
#
|
|
75
|
+
# ```
|
|
73
76
|
# bindings:
|
|
74
77
|
# - members:
|
|
75
78
|
# - user:mike@example.com
|
|
@@ -86,6 +89,7 @@ module Google
|
|
|
86
89
|
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
|
|
87
90
|
# etag: BwWWja0YfJA=
|
|
88
91
|
# version: 3
|
|
92
|
+
# ```
|
|
89
93
|
#
|
|
90
94
|
# For a description of IAM and its features, see the
|
|
91
95
|
# [IAM documentation](https://cloud.google.com/iam/docs/).
|
|
@@ -157,7 +161,7 @@ module Google
|
|
|
157
161
|
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
|
158
162
|
# @!attribute [rw] members
|
|
159
163
|
# @return [::Array<::String>]
|
|
160
|
-
# Specifies the principals requesting access for a Cloud
|
|
164
|
+
# Specifies the principals requesting access for a Google Cloud resource.
|
|
161
165
|
# `members` can have the following values:
|
|
162
166
|
#
|
|
163
167
|
# * `allUsers`: A special identifier that represents anyone who is
|
|
@@ -267,8 +271,8 @@ module Google
|
|
|
267
271
|
# }
|
|
268
272
|
#
|
|
269
273
|
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
|
|
270
|
-
# logging. It also exempts jose@example.com from DATA_READ logging, and
|
|
271
|
-
# aliya@example.com from DATA_WRITE logging.
|
|
274
|
+
# logging. It also exempts `jose@example.com` from DATA_READ logging, and
|
|
275
|
+
# `aliya@example.com` from DATA_WRITE logging.
|
|
272
276
|
# @!attribute [rw] service
|
|
273
277
|
# @return [::String]
|
|
274
278
|
# Specifies a service that will be enabled for audit logging.
|
|
@@ -356,7 +360,7 @@ module Google
|
|
|
356
360
|
# Required
|
|
357
361
|
# @!attribute [rw] member
|
|
358
362
|
# @return [::String]
|
|
359
|
-
# A single identity requesting access for a Cloud
|
|
363
|
+
# A single identity requesting access for a Google Cloud resource.
|
|
360
364
|
# Follows the same format of Binding.members.
|
|
361
365
|
# Required
|
|
362
366
|
# @!attribute [rw] condition
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-tasks-v2beta3
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.11.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-
|
|
11
|
+
date: 2023-09-12 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.20.0
|
|
20
20
|
- - "<"
|
|
21
21
|
- !ruby/object:Gem::Version
|
|
22
22
|
version: 2.a
|
|
@@ -26,7 +26,7 @@ dependencies:
|
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.
|
|
29
|
+
version: 0.20.0
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -44,6 +44,26 @@ dependencies:
|
|
|
44
44
|
- - "~>"
|
|
45
45
|
- !ruby/object:Gem::Version
|
|
46
46
|
version: '1.0'
|
|
47
|
+
- !ruby/object:Gem::Dependency
|
|
48
|
+
name: google-cloud-location
|
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - ">="
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '0.4'
|
|
54
|
+
- - "<"
|
|
55
|
+
- !ruby/object:Gem::Version
|
|
56
|
+
version: 2.a
|
|
57
|
+
type: :runtime
|
|
58
|
+
prerelease: false
|
|
59
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
60
|
+
requirements:
|
|
61
|
+
- - ">="
|
|
62
|
+
- !ruby/object:Gem::Version
|
|
63
|
+
version: '0.4'
|
|
64
|
+
- - "<"
|
|
65
|
+
- !ruby/object:Gem::Version
|
|
66
|
+
version: 2.a
|
|
47
67
|
- !ruby/object:Gem::Dependency
|
|
48
68
|
name: grpc-google-iam-v1
|
|
49
69
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -187,6 +207,7 @@ files:
|
|
|
187
207
|
- README.md
|
|
188
208
|
- lib/google-cloud-tasks-v2beta3.rb
|
|
189
209
|
- lib/google/cloud/tasks/v2beta3.rb
|
|
210
|
+
- lib/google/cloud/tasks/v2beta3/bindings_override.rb
|
|
190
211
|
- lib/google/cloud/tasks/v2beta3/cloud_tasks.rb
|
|
191
212
|
- lib/google/cloud/tasks/v2beta3/cloud_tasks/client.rb
|
|
192
213
|
- lib/google/cloud/tasks/v2beta3/cloud_tasks/credentials.rb
|
|
@@ -204,6 +225,7 @@ files:
|
|
|
204
225
|
- proto_docs/README.md
|
|
205
226
|
- proto_docs/google/api/client.rb
|
|
206
227
|
- proto_docs/google/api/field_behavior.rb
|
|
228
|
+
- proto_docs/google/api/httpbody.rb
|
|
207
229
|
- proto_docs/google/api/launch_stage.rb
|
|
208
230
|
- proto_docs/google/api/resource.rb
|
|
209
231
|
- proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb
|
|
@@ -239,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
239
261
|
- !ruby/object:Gem::Version
|
|
240
262
|
version: '0'
|
|
241
263
|
requirements: []
|
|
242
|
-
rubygems_version: 3.4.
|
|
264
|
+
rubygems_version: 3.4.19
|
|
243
265
|
signing_key:
|
|
244
266
|
specification_version: 4
|
|
245
267
|
summary: Manages the execution of large numbers of distributed requests.
|