google-cloud-tasks 0.3.0 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb +210 -181
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +79 -63
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb +178 -146
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb +103 -68
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb +110 -71
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/task.rb +43 -25
- data/lib/google/cloud/tasks/v2beta2/doc/google/rpc/status.rb +17 -14
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb +123 -104
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb +51 -39
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/cloudtasks.rb +116 -92
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/queue.rb +84 -55
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/target.rb +175 -52
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/task.rb +40 -16
- data/lib/google/cloud/tasks/v2beta3/doc/google/rpc/status.rb +17 -14
- data/lib/google/cloud/tasks/v2beta3/target_pb.rb +7 -0
- data/lib/google/cloud/tasks/v2beta3/task_pb.rb +1 -0
- metadata +4 -4
|
@@ -22,8 +22,9 @@ module Google
|
|
|
22
22
|
# retry options, target types, and others.
|
|
23
23
|
# @!attribute [rw] name
|
|
24
24
|
# @return [String]
|
|
25
|
-
# Caller-specified and required in
|
|
26
|
-
#
|
|
25
|
+
# Caller-specified and required in
|
|
26
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateQueue CreateQueue}, after
|
|
27
|
+
# which it becomes output only.
|
|
27
28
|
#
|
|
28
29
|
# The queue name.
|
|
29
30
|
#
|
|
@@ -33,7 +34,8 @@ module Google
|
|
|
33
34
|
# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
|
|
34
35
|
# hyphens (-), colons (:), or periods (.).
|
|
35
36
|
# For more information, see
|
|
36
|
-
# [Identifying
|
|
37
|
+
# [Identifying
|
|
38
|
+
# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
|
|
37
39
|
# * `LOCATION_ID` is the canonical ID for the queue's location.
|
|
38
40
|
# The list of available locations can be obtained by calling
|
|
39
41
|
# {Google::Cloud::Location::Locations::ListLocations ListLocations}.
|
|
@@ -44,29 +46,33 @@ module Google
|
|
|
44
46
|
# @return [Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget]
|
|
45
47
|
# App Engine HTTP target.
|
|
46
48
|
#
|
|
47
|
-
# An App Engine queue is a queue that has an
|
|
49
|
+
# An App Engine queue is a queue that has an
|
|
50
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget AppEngineHttpTarget}.
|
|
48
51
|
# @!attribute [rw] pull_target
|
|
49
52
|
# @return [Google::Cloud::Tasks::V2beta2::PullTarget]
|
|
50
53
|
# Pull target.
|
|
51
54
|
#
|
|
52
|
-
# A pull queue is a queue that has a
|
|
55
|
+
# A pull queue is a queue that has a
|
|
56
|
+
# {Google::Cloud::Tasks::V2beta2::PullTarget PullTarget}.
|
|
53
57
|
# @!attribute [rw] rate_limits
|
|
54
58
|
# @return [Google::Cloud::Tasks::V2beta2::RateLimits]
|
|
55
59
|
# Rate limits for task dispatches.
|
|
56
60
|
#
|
|
57
61
|
# {Google::Cloud::Tasks::V2beta2::Queue#rate_limits rate_limits} and
|
|
58
|
-
# {Google::Cloud::Tasks::V2beta2::Queue#retry_config retry_config} are related
|
|
59
|
-
# control task attempts however they control how tasks are
|
|
62
|
+
# {Google::Cloud::Tasks::V2beta2::Queue#retry_config retry_config} are related
|
|
63
|
+
# because they both control task attempts however they control how tasks are
|
|
60
64
|
# attempted in different ways:
|
|
61
65
|
#
|
|
62
|
-
# * {Google::Cloud::Tasks::V2beta2::Queue#rate_limits rate_limits} controls the
|
|
66
|
+
# * {Google::Cloud::Tasks::V2beta2::Queue#rate_limits rate_limits} controls the
|
|
67
|
+
# total rate of
|
|
63
68
|
# dispatches from a queue (i.e. all traffic dispatched from the
|
|
64
69
|
# queue, regardless of whether the dispatch is from a first
|
|
65
70
|
# attempt or a retry).
|
|
66
|
-
# * {Google::Cloud::Tasks::V2beta2::Queue#retry_config retry_config} controls
|
|
71
|
+
# * {Google::Cloud::Tasks::V2beta2::Queue#retry_config retry_config} controls
|
|
72
|
+
# what happens to
|
|
67
73
|
# particular a task after its first attempt fails. That is,
|
|
68
|
-
# {Google::Cloud::Tasks::V2beta2::Queue#retry_config retry_config} controls
|
|
69
|
-
# second attempt, third attempt, etc).
|
|
74
|
+
# {Google::Cloud::Tasks::V2beta2::Queue#retry_config retry_config} controls
|
|
75
|
+
# task retries (the second attempt, third attempt, etc).
|
|
70
76
|
# @!attribute [rw] retry_config
|
|
71
77
|
# @return [Google::Cloud::Tasks::V2beta2::RetryConfig]
|
|
72
78
|
# Settings that determine the retry behavior.
|
|
@@ -77,25 +83,30 @@ module Google
|
|
|
77
83
|
# * For tasks created using the App Engine SDK: the queue-level retry
|
|
78
84
|
# settings apply to all tasks in the queue which do not have retry settings
|
|
79
85
|
# explicitly set on the task and were created by the App Engine SDK. See
|
|
80
|
-
# [App Engine
|
|
86
|
+
# [App Engine
|
|
87
|
+
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
|
|
81
88
|
# @!attribute [rw] state
|
|
82
89
|
# @return [Google::Cloud::Tasks::V2beta2::Queue::State]
|
|
83
90
|
# Output only. The state of the queue.
|
|
84
91
|
#
|
|
85
92
|
# `state` can only be changed by called
|
|
86
93
|
# {Google::Cloud::Tasks::V2beta2::CloudTasks::PauseQueue PauseQueue},
|
|
87
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ResumeQueue ResumeQueue}, or
|
|
94
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ResumeQueue ResumeQueue}, or
|
|
95
|
+
# uploading
|
|
88
96
|
# [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
|
|
89
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::UpdateQueue UpdateQueue} cannot be
|
|
97
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::UpdateQueue UpdateQueue} cannot be
|
|
98
|
+
# used to change `state`.
|
|
90
99
|
# @!attribute [rw] purge_time
|
|
91
100
|
# @return [Google::Protobuf::Timestamp]
|
|
92
101
|
# Output only. The last time this queue was purged.
|
|
93
102
|
#
|
|
94
|
-
# All tasks that were {Google::Cloud::Tasks::V2beta2::Task#create_time created}
|
|
95
|
-
# were purged.
|
|
103
|
+
# All tasks that were {Google::Cloud::Tasks::V2beta2::Task#create_time created}
|
|
104
|
+
# before this time were purged.
|
|
96
105
|
#
|
|
97
|
-
# A queue can be purged using
|
|
98
|
-
#
|
|
106
|
+
# A queue can be purged using
|
|
107
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::PurgeQueue PurgeQueue}, the [App
|
|
108
|
+
# Engine Task Queue SDK, or the Cloud
|
|
109
|
+
# Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
|
|
99
110
|
#
|
|
100
111
|
# Purge time will be truncated to the nearest microsecond. Purge
|
|
101
112
|
# time will be unset if the queue has never been purged.
|
|
@@ -118,21 +129,23 @@ module Google
|
|
|
118
129
|
# Tasks are paused by the user. If the queue is paused then Cloud
|
|
119
130
|
# Tasks will stop delivering tasks from it, but more tasks can
|
|
120
131
|
# still be added to it by the user. When a pull queue is paused,
|
|
121
|
-
# all {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} calls
|
|
122
|
-
# {Google::Rpc::Code::FAILED_PRECONDITION FAILED_PRECONDITION}.
|
|
132
|
+
# all {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} calls
|
|
133
|
+
# will return a {Google::Rpc::Code::FAILED_PRECONDITION FAILED_PRECONDITION}.
|
|
123
134
|
PAUSED = 2
|
|
124
135
|
|
|
125
136
|
# The queue is disabled.
|
|
126
137
|
#
|
|
127
138
|
# A queue becomes `DISABLED` when
|
|
128
|
-
# [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref)
|
|
129
|
-
#
|
|
130
|
-
#
|
|
139
|
+
# [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref)
|
|
140
|
+
# or
|
|
141
|
+
# [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref)
|
|
142
|
+
# is uploaded which does not contain the queue. You cannot directly disable
|
|
143
|
+
# a queue.
|
|
131
144
|
#
|
|
132
145
|
# When a queue is disabled, tasks can still be added to a queue
|
|
133
146
|
# but the tasks are not dispatched and
|
|
134
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} calls
|
|
135
|
-
# `FAILED_PRECONDITION` error.
|
|
147
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} calls
|
|
148
|
+
# return a `FAILED_PRECONDITION` error.
|
|
136
149
|
#
|
|
137
150
|
# To permanently delete this queue and all of its tasks, call
|
|
138
151
|
# {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue DeleteQueue}.
|
|
@@ -145,8 +158,10 @@ module Google
|
|
|
145
158
|
# This message determines the maximum rate that tasks can be dispatched by a
|
|
146
159
|
# queue, regardless of whether the dispatch is a first task attempt or a retry.
|
|
147
160
|
#
|
|
148
|
-
# Note: The debugging command,
|
|
149
|
-
#
|
|
161
|
+
# Note: The debugging command,
|
|
162
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::RunTask RunTask}, will run a task
|
|
163
|
+
# even if the queue has reached its
|
|
164
|
+
# {Google::Cloud::Tasks::V2beta2::RateLimits RateLimits}.
|
|
150
165
|
# @!attribute [rw] max_tasks_dispatched_per_second
|
|
151
166
|
# @return [Float]
|
|
152
167
|
# The maximum rate at which tasks are dispatched from this queue.
|
|
@@ -154,15 +169,19 @@ module Google
|
|
|
154
169
|
# If unspecified when the queue is created, Cloud Tasks will pick the
|
|
155
170
|
# default.
|
|
156
171
|
#
|
|
157
|
-
# * For {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues},
|
|
172
|
+
# * For {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues},
|
|
173
|
+
# the maximum allowed value
|
|
158
174
|
# is 500.
|
|
159
|
-
# * This field is output only for
|
|
175
|
+
# * This field is output only for [pull
|
|
176
|
+
# queues][google.cloud.tasks.v2beta2.PullTarget]. In addition to the
|
|
160
177
|
# `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
|
|
161
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} requests
|
|
178
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} requests
|
|
179
|
+
# are allowed per pull queue.
|
|
162
180
|
#
|
|
163
181
|
#
|
|
164
182
|
# This field has the same meaning as
|
|
165
|
-
# [rate in
|
|
183
|
+
# [rate in
|
|
184
|
+
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
|
|
166
185
|
# @!attribute [rw] max_burst_size
|
|
167
186
|
# @return [Integer]
|
|
168
187
|
# Output only. The max burst size.
|
|
@@ -190,9 +209,9 @@ module Google
|
|
|
190
209
|
# `queue.yaml/xml`, `max_burst_size` is equal to
|
|
191
210
|
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
|
|
192
211
|
# Since `max_burst_size` is output only, if
|
|
193
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::UpdateQueue UpdateQueue} is called
|
|
194
|
-
# created by `queue.yaml/xml`, `max_burst_size` will be reset
|
|
195
|
-
# on the value of
|
|
212
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::UpdateQueue UpdateQueue} is called
|
|
213
|
+
# on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset
|
|
214
|
+
# based on the value of
|
|
196
215
|
# {Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second},
|
|
197
216
|
# regardless of whether
|
|
198
217
|
# {Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second}
|
|
@@ -211,12 +230,14 @@ module Google
|
|
|
211
230
|
# The maximum allowed value is 5,000.
|
|
212
231
|
#
|
|
213
232
|
# This field is output only for
|
|
214
|
-
# {Google::Cloud::Tasks::V2beta2::PullTarget pull queues} and always -1, which
|
|
215
|
-
# queue types can have `max_concurrent_tasks`
|
|
233
|
+
# {Google::Cloud::Tasks::V2beta2::PullTarget pull queues} and always -1, which
|
|
234
|
+
# indicates no limit. No other queue types can have `max_concurrent_tasks`
|
|
235
|
+
# set to -1.
|
|
216
236
|
#
|
|
217
237
|
#
|
|
218
238
|
# This field has the same meaning as
|
|
219
|
-
# [max_concurrent_requests in
|
|
239
|
+
# [max_concurrent_requests in
|
|
240
|
+
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
|
|
220
241
|
class RateLimits; end
|
|
221
242
|
|
|
222
243
|
# Retry config.
|
|
@@ -237,87 +258,101 @@ module Google
|
|
|
237
258
|
# If positive, `max_retry_duration` specifies the time limit for
|
|
238
259
|
# retrying a failed task, measured from when the task was first
|
|
239
260
|
# attempted. Once `max_retry_duration` time has passed *and* the
|
|
240
|
-
# task has been attempted
|
|
241
|
-
# times,
|
|
242
|
-
# deleted.
|
|
261
|
+
# task has been attempted
|
|
262
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_attempts max_attempts} times,
|
|
263
|
+
# no further attempts will be made and the task will be deleted.
|
|
243
264
|
#
|
|
244
265
|
# If zero, then the task age is unlimited.
|
|
245
266
|
#
|
|
246
267
|
# If unspecified when the queue is created, Cloud Tasks will pick the
|
|
247
268
|
# default.
|
|
248
269
|
#
|
|
249
|
-
# This field is output only for
|
|
270
|
+
# This field is output only for [pull
|
|
271
|
+
# queues][google.cloud.tasks.v2beta2.PullTarget].
|
|
250
272
|
#
|
|
251
273
|
#
|
|
252
274
|
# `max_retry_duration` will be truncated to the nearest second.
|
|
253
275
|
#
|
|
254
276
|
# This field has the same meaning as
|
|
255
|
-
# [task_age_limit in
|
|
277
|
+
# [task_age_limit in
|
|
278
|
+
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
|
|
256
279
|
# @!attribute [rw] min_backoff
|
|
257
280
|
# @return [Google::Protobuf::Duration]
|
|
258
|
-
# A task will be {Google::Cloud::Tasks::V2beta2::Task#schedule_time scheduled}
|
|
281
|
+
# A task will be {Google::Cloud::Tasks::V2beta2::Task#schedule_time scheduled}
|
|
282
|
+
# for retry between
|
|
259
283
|
# {Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff} and
|
|
260
|
-
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} duration
|
|
261
|
-
# if the queue's
|
|
262
|
-
#
|
|
284
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} duration
|
|
285
|
+
# after it fails, if the queue's
|
|
286
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig} specifies that the
|
|
287
|
+
# task should be retried.
|
|
263
288
|
#
|
|
264
289
|
# If unspecified when the queue is created, Cloud Tasks will pick the
|
|
265
290
|
# default.
|
|
266
291
|
#
|
|
267
|
-
# This field is output only for
|
|
292
|
+
# This field is output only for [pull
|
|
293
|
+
# queues][google.cloud.tasks.v2beta2.PullTarget].
|
|
268
294
|
#
|
|
269
295
|
#
|
|
270
296
|
# `min_backoff` will be truncated to the nearest second.
|
|
271
297
|
#
|
|
272
298
|
# This field has the same meaning as
|
|
273
|
-
# [min_backoff_seconds in
|
|
299
|
+
# [min_backoff_seconds in
|
|
300
|
+
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
|
|
274
301
|
# @!attribute [rw] max_backoff
|
|
275
302
|
# @return [Google::Protobuf::Duration]
|
|
276
|
-
# A task will be {Google::Cloud::Tasks::V2beta2::Task#schedule_time scheduled}
|
|
303
|
+
# A task will be {Google::Cloud::Tasks::V2beta2::Task#schedule_time scheduled}
|
|
304
|
+
# for retry between
|
|
277
305
|
# {Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff} and
|
|
278
|
-
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} duration
|
|
279
|
-
# if the queue's
|
|
280
|
-
#
|
|
306
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} duration
|
|
307
|
+
# after it fails, if the queue's
|
|
308
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig} specifies that the
|
|
309
|
+
# task should be retried.
|
|
281
310
|
#
|
|
282
311
|
# If unspecified when the queue is created, Cloud Tasks will pick the
|
|
283
312
|
# default.
|
|
284
313
|
#
|
|
285
|
-
# This field is output only for
|
|
314
|
+
# This field is output only for [pull
|
|
315
|
+
# queues][google.cloud.tasks.v2beta2.PullTarget].
|
|
286
316
|
#
|
|
287
317
|
#
|
|
288
318
|
# `max_backoff` will be truncated to the nearest second.
|
|
289
319
|
#
|
|
290
320
|
# This field has the same meaning as
|
|
291
|
-
# [max_backoff_seconds in
|
|
321
|
+
# [max_backoff_seconds in
|
|
322
|
+
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
|
|
292
323
|
# @!attribute [rw] max_doublings
|
|
293
324
|
# @return [Integer]
|
|
294
325
|
# The time between retries will double `max_doublings` times.
|
|
295
326
|
#
|
|
296
327
|
# A task's retry interval starts at
|
|
297
|
-
# {Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff}, then
|
|
298
|
-
# `max_doublings` times, then increases linearly, and finally
|
|
299
|
-
# retries
|
|
328
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff}, then
|
|
329
|
+
# doubles `max_doublings` times, then increases linearly, and finally retries
|
|
330
|
+
# retries at intervals of
|
|
300
331
|
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} up to
|
|
301
332
|
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_attempts max_attempts} times.
|
|
302
333
|
#
|
|
303
|
-
# For example, if
|
|
304
|
-
# {Google::Cloud::Tasks::V2beta2::RetryConfig#
|
|
305
|
-
#
|
|
306
|
-
#
|
|
307
|
-
# increase linearly by 2^3 *
|
|
308
|
-
#
|
|
309
|
-
#
|
|
310
|
-
#
|
|
311
|
-
#
|
|
334
|
+
# For example, if
|
|
335
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff} is 10s,
|
|
336
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} is 300s,
|
|
337
|
+
# and `max_doublings` is 3, then the a task will first be retried in 10s. The
|
|
338
|
+
# retry interval will double three times, and then increase linearly by 2^3 *
|
|
339
|
+
# 10s. Finally, the task will retry at intervals of
|
|
340
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} until the
|
|
341
|
+
# task has been attempted
|
|
342
|
+
# {Google::Cloud::Tasks::V2beta2::RetryConfig#max_attempts max_attempts} times.
|
|
343
|
+
# Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,
|
|
344
|
+
# 300s, ....
|
|
312
345
|
#
|
|
313
346
|
# If unspecified when the queue is created, Cloud Tasks will pick the
|
|
314
347
|
# default.
|
|
315
348
|
#
|
|
316
|
-
# This field is output only for
|
|
349
|
+
# This field is output only for [pull
|
|
350
|
+
# queues][google.cloud.tasks.v2beta2.PullTarget].
|
|
317
351
|
#
|
|
318
352
|
#
|
|
319
353
|
# This field has the same meaning as
|
|
320
|
-
# [max_doublings in
|
|
354
|
+
# [max_doublings in
|
|
355
|
+
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
|
|
321
356
|
class RetryConfig; end
|
|
322
357
|
end
|
|
323
358
|
end
|
|
@@ -21,7 +21,8 @@ module Google
|
|
|
21
21
|
class PullTarget; end
|
|
22
22
|
|
|
23
23
|
# The pull message contains data that can be used by the caller of
|
|
24
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} to process the
|
|
24
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} to process the
|
|
25
|
+
# task.
|
|
25
26
|
#
|
|
26
27
|
# This proto can only be used for tasks in a queue which has
|
|
27
28
|
# {Google::Cloud::Tasks::V2beta2::Queue#pull_target pull_target} set.
|
|
@@ -34,10 +35,11 @@ module Google
|
|
|
34
35
|
#
|
|
35
36
|
# Tags allow similar tasks to be processed in a batch. If you label
|
|
36
37
|
# tasks with a tag, your worker can
|
|
37
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks lease tasks} with the
|
|
38
|
-
#
|
|
39
|
-
#
|
|
40
|
-
# you
|
|
38
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks lease tasks} with the
|
|
39
|
+
# same tag using
|
|
40
|
+
# {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter}. For example,
|
|
41
|
+
# if you want to aggregate the events associated with a specific user once a
|
|
42
|
+
# day, you could tag tasks with the user ID.
|
|
41
43
|
#
|
|
42
44
|
# The task's tag can only be set when the
|
|
43
45
|
# {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask task is created}.
|
|
@@ -45,7 +47,8 @@ module Google
|
|
|
45
47
|
# The tag must be less than 500 characters.
|
|
46
48
|
#
|
|
47
49
|
# SDK compatibility: Although the SDK allows tags to be either
|
|
48
|
-
# string or
|
|
50
|
+
# string or
|
|
51
|
+
# [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
|
|
49
52
|
# only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
|
|
50
53
|
# encoded, the tag will be empty when the task is returned by Cloud Tasks.
|
|
51
54
|
class PullMessage; end
|
|
@@ -53,11 +56,15 @@ module Google
|
|
|
53
56
|
# App Engine HTTP target.
|
|
54
57
|
#
|
|
55
58
|
# The task will be delivered to the App Engine application hostname
|
|
56
|
-
# specified by its
|
|
57
|
-
#
|
|
58
|
-
#
|
|
59
|
-
#
|
|
60
|
-
#
|
|
59
|
+
# specified by its
|
|
60
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget AppEngineHttpTarget} and
|
|
61
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest AppEngineHttpRequest}. The
|
|
62
|
+
# documentation for
|
|
63
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest AppEngineHttpRequest}
|
|
64
|
+
# explains how the task's host URL is constructed.
|
|
65
|
+
#
|
|
66
|
+
# Using {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget AppEngineHttpTarget}
|
|
67
|
+
# requires
|
|
61
68
|
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
|
|
62
69
|
# Google IAM permission for the project
|
|
63
70
|
# and the following scope:
|
|
@@ -66,11 +73,13 @@ module Google
|
|
|
66
73
|
# @!attribute [rw] app_engine_routing_override
|
|
67
74
|
# @return [Google::Cloud::Tasks::V2beta2::AppEngineRouting]
|
|
68
75
|
# Overrides for the
|
|
69
|
-
#
|
|
76
|
+
# [task-level
|
|
77
|
+
# app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
|
|
70
78
|
#
|
|
71
79
|
# If set, `app_engine_routing_override` is used for all tasks in
|
|
72
80
|
# the queue, no matter what the setting is for the
|
|
73
|
-
#
|
|
81
|
+
# [task-level
|
|
82
|
+
# app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
|
|
74
83
|
class AppEngineHttpTarget; end
|
|
75
84
|
|
|
76
85
|
# App Engine HTTP request.
|
|
@@ -79,9 +88,11 @@ module Google
|
|
|
79
88
|
# the task is dispatched.
|
|
80
89
|
#
|
|
81
90
|
# This proto can only be used for tasks in a queue which has
|
|
82
|
-
# {Google::Cloud::Tasks::V2beta2::Queue#app_engine_http_target app_engine_http_target}
|
|
91
|
+
# {Google::Cloud::Tasks::V2beta2::Queue#app_engine_http_target app_engine_http_target}
|
|
92
|
+
# set.
|
|
83
93
|
#
|
|
84
|
-
# Using {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest AppEngineHttpRequest}
|
|
94
|
+
# Using {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest AppEngineHttpRequest}
|
|
95
|
+
# requires
|
|
85
96
|
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
|
|
86
97
|
# Google IAM permission for the project
|
|
87
98
|
# and the following scope:
|
|
@@ -90,18 +101,22 @@ module Google
|
|
|
90
101
|
#
|
|
91
102
|
# The task will be delivered to the App Engine app which belongs to the same
|
|
92
103
|
# project as the queue. For more information, see
|
|
93
|
-
# [How Requests are
|
|
104
|
+
# [How Requests are
|
|
105
|
+
# Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
|
|
94
106
|
# and how routing is affected by
|
|
95
|
-
# [dispatch
|
|
107
|
+
# [dispatch
|
|
108
|
+
# files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
|
|
96
109
|
#
|
|
97
|
-
# The {Google::Cloud::Tasks::V2beta2::AppEngineRouting AppEngineRouting} used to
|
|
98
|
-
# delivered to can be set at the queue-level
|
|
110
|
+
# The {Google::Cloud::Tasks::V2beta2::AppEngineRouting AppEngineRouting} used to
|
|
111
|
+
# construct the URL that the task is delivered to can be set at the queue-level
|
|
112
|
+
# or task-level:
|
|
99
113
|
#
|
|
100
114
|
# * If set,
|
|
101
115
|
# {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget#app_engine_routing_override app_engine_routing_override}
|
|
102
116
|
# is used for all tasks in the queue, no matter what the setting
|
|
103
117
|
# is for the
|
|
104
|
-
#
|
|
118
|
+
# [task-level
|
|
119
|
+
# app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
|
|
105
120
|
#
|
|
106
121
|
#
|
|
107
122
|
# The `url` that the task will be sent to is:
|
|
@@ -123,10 +138,12 @@ module Google
|
|
|
123
138
|
# The app's request handler for the task's target URL must be able to handle
|
|
124
139
|
# HTTP requests with this http_method, otherwise the task attempt will fail
|
|
125
140
|
# with error code 405 (Method Not Allowed). See
|
|
126
|
-
# [Writing a push task request
|
|
141
|
+
# [Writing a push task request
|
|
142
|
+
# handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
|
|
127
143
|
# and the documentation for the request handlers in the language your app is
|
|
128
144
|
# written in e.g.
|
|
129
|
-
# [Python Request
|
|
145
|
+
# [Python Request
|
|
146
|
+
# Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
|
|
130
147
|
# @!attribute [rw] app_engine_routing
|
|
131
148
|
# @return [Google::Cloud::Tasks::V2beta2::AppEngineRouting]
|
|
132
149
|
# Task-level setting for App Engine routing.
|
|
@@ -134,7 +151,8 @@ module Google
|
|
|
134
151
|
# If set,
|
|
135
152
|
# {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget#app_engine_routing_override app_engine_routing_override}
|
|
136
153
|
# is used for all tasks in the queue, no matter what the setting is for the
|
|
137
|
-
#
|
|
154
|
+
# [task-level
|
|
155
|
+
# app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
|
|
138
156
|
# @!attribute [rw] relative_url
|
|
139
157
|
# @return [String]
|
|
140
158
|
# The relative URL.
|
|
@@ -160,7 +178,8 @@ module Google
|
|
|
160
178
|
# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
|
|
161
179
|
# modified `User-Agent`.
|
|
162
180
|
#
|
|
163
|
-
# If the task has a
|
|
181
|
+
# If the task has a
|
|
182
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#payload payload}, Cloud
|
|
164
183
|
# Tasks sets the following headers:
|
|
165
184
|
#
|
|
166
185
|
# * `Content-Type`: By default, the `Content-Type` header is set to
|
|
@@ -179,13 +198,16 @@ module Google
|
|
|
179
198
|
#
|
|
180
199
|
# In addition, Cloud Tasks sets some headers when the task is dispatched,
|
|
181
200
|
# such as headers containing information about the task; see
|
|
182
|
-
# [request
|
|
201
|
+
# [request
|
|
202
|
+
# headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
|
|
183
203
|
# These headers are set only when the task is dispatched, so they are not
|
|
184
204
|
# visible when the task is returned in a Cloud Tasks response.
|
|
185
205
|
#
|
|
186
206
|
# Although there is no specific limit for the maximum number of headers or
|
|
187
|
-
# the size, there is a limit on the maximum size of the
|
|
188
|
-
#
|
|
207
|
+
# the size, there is a limit on the maximum size of the
|
|
208
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task}. For more information, see the
|
|
209
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask CreateTask}
|
|
210
|
+
# documentation.
|
|
189
211
|
# @!attribute [rw] payload
|
|
190
212
|
# @return [String]
|
|
191
213
|
# Payload.
|
|
@@ -199,10 +221,14 @@ module Google
|
|
|
199
221
|
# App Engine Routing.
|
|
200
222
|
#
|
|
201
223
|
# For more information about services, versions, and instances see
|
|
202
|
-
# [An Overview of App
|
|
203
|
-
#
|
|
204
|
-
# [
|
|
205
|
-
#
|
|
224
|
+
# [An Overview of App
|
|
225
|
+
# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
|
|
226
|
+
# [Microservices Architecture on Google App
|
|
227
|
+
# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
|
|
228
|
+
# [App Engine Standard request
|
|
229
|
+
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
|
|
230
|
+
# and [App Engine Flex request
|
|
231
|
+
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
|
|
206
232
|
# @!attribute [rw] service
|
|
207
233
|
# @return [String]
|
|
208
234
|
# App service.
|
|
@@ -211,16 +237,18 @@ module Google
|
|
|
211
237
|
# service when the task is attempted.
|
|
212
238
|
#
|
|
213
239
|
# For some queues or tasks which were created using the App Engine
|
|
214
|
-
# Task Queue API, {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is
|
|
215
|
-
#
|
|
216
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
|
|
217
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}. For example, some tasks
|
|
218
|
-
# which were created using the App Engine SDK use a custom domain
|
|
219
|
-
# name; custom domains are not parsed by Cloud Tasks. If
|
|
220
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is not parsable, then
|
|
240
|
+
# Task Queue API, {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is
|
|
241
|
+
# not parsable into
|
|
221
242
|
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
|
|
222
243
|
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
|
|
223
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}
|
|
244
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}. For
|
|
245
|
+
# example, some tasks which were created using the App Engine SDK use a
|
|
246
|
+
# custom domain name; custom domains are not parsed by Cloud Tasks. If
|
|
247
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is not parsable,
|
|
248
|
+
# then {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
|
|
249
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
|
|
250
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} are the
|
|
251
|
+
# empty string.
|
|
224
252
|
# @!attribute [rw] version
|
|
225
253
|
# @return [String]
|
|
226
254
|
# App version.
|
|
@@ -229,16 +257,18 @@ module Google
|
|
|
229
257
|
# version when the task is attempted.
|
|
230
258
|
#
|
|
231
259
|
# For some queues or tasks which were created using the App Engine
|
|
232
|
-
# Task Queue API, {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is
|
|
233
|
-
#
|
|
234
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
|
|
235
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}. For example, some tasks
|
|
236
|
-
# which were created using the App Engine SDK use a custom domain
|
|
237
|
-
# name; custom domains are not parsed by Cloud Tasks. If
|
|
238
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is not parsable, then
|
|
260
|
+
# Task Queue API, {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is
|
|
261
|
+
# not parsable into
|
|
239
262
|
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
|
|
240
263
|
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
|
|
241
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}
|
|
264
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}. For
|
|
265
|
+
# example, some tasks which were created using the App Engine SDK use a
|
|
266
|
+
# custom domain name; custom domains are not parsed by Cloud Tasks. If
|
|
267
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is not parsable,
|
|
268
|
+
# then {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
|
|
269
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
|
|
270
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} are the
|
|
271
|
+
# empty string.
|
|
242
272
|
# @!attribute [rw] instance
|
|
243
273
|
# @return [String]
|
|
244
274
|
# App instance.
|
|
@@ -247,16 +277,20 @@ module Google
|
|
|
247
277
|
# the task is attempted.
|
|
248
278
|
#
|
|
249
279
|
# Requests can only be sent to a specific instance if
|
|
250
|
-
# [manual scaling is used in App Engine
|
|
280
|
+
# [manual scaling is used in App Engine
|
|
281
|
+
# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
|
|
251
282
|
# App Engine Flex does not support instances. For more information, see
|
|
252
|
-
# [App Engine Standard request
|
|
253
|
-
#
|
|
283
|
+
# [App Engine Standard request
|
|
284
|
+
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
|
|
285
|
+
# and [App Engine Flex request
|
|
286
|
+
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
|
|
254
287
|
# @!attribute [rw] host
|
|
255
288
|
# @return [String]
|
|
256
289
|
# Output only. The host that the task is sent to.
|
|
257
290
|
#
|
|
258
291
|
# For more information, see
|
|
259
|
-
# [How Requests are
|
|
292
|
+
# [How Requests are
|
|
293
|
+
# Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
|
|
260
294
|
#
|
|
261
295
|
# The host is constructed as:
|
|
262
296
|
#
|
|
@@ -275,44 +309,49 @@ module Google
|
|
|
275
309
|
# queue's project ID. Some tasks which were created using the App Engine
|
|
276
310
|
# SDK use a custom domain name.
|
|
277
311
|
#
|
|
278
|
-
# * `service =`
|
|
312
|
+
# * `service =`
|
|
313
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
|
|
279
314
|
#
|
|
280
|
-
# * `version =`
|
|
315
|
+
# * `version =`
|
|
316
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}
|
|
281
317
|
#
|
|
282
318
|
# * `version_dot_service =`
|
|
283
319
|
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} `+ '.' +`
|
|
284
320
|
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
|
|
285
321
|
#
|
|
286
|
-
# * `instance =`
|
|
322
|
+
# * `instance =`
|
|
323
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}
|
|
287
324
|
#
|
|
288
325
|
# * `instance_dot_service =`
|
|
289
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.'
|
|
290
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
|
|
326
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.'
|
|
327
|
+
# +` {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
|
|
291
328
|
#
|
|
292
329
|
# * `instance_dot_version =`
|
|
293
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.'
|
|
294
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}
|
|
330
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.'
|
|
331
|
+
# +` {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}
|
|
295
332
|
#
|
|
296
333
|
# * `instance_dot_version_dot_service =`
|
|
297
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.'
|
|
298
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} `+ '.'
|
|
299
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
|
|
334
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.'
|
|
335
|
+
# +` {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} `+ '.'
|
|
336
|
+
# +` {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
|
|
300
337
|
#
|
|
301
|
-
# If {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service} is empty,
|
|
302
|
-
# to the service which is the default service when
|
|
338
|
+
# If {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service} is empty,
|
|
339
|
+
# then the task will be sent to the service which is the default service when
|
|
340
|
+
# the task is attempted.
|
|
303
341
|
#
|
|
304
|
-
# If {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} is empty,
|
|
305
|
-
# to the version which is the default version when
|
|
342
|
+
# If {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} is empty,
|
|
343
|
+
# then the task will be sent to the version which is the default version when
|
|
344
|
+
# the task is attempted.
|
|
306
345
|
#
|
|
307
|
-
# If {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} is
|
|
308
|
-
# will be sent to an instance which is available when
|
|
309
|
-
# attempted.
|
|
346
|
+
# If {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} is
|
|
347
|
+
# empty, then the task will be sent to an instance which is available when
|
|
348
|
+
# the task is attempted.
|
|
310
349
|
#
|
|
311
350
|
# If {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
|
|
312
351
|
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, or
|
|
313
|
-
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} is
|
|
314
|
-
# will be sent to the default version of the default
|
|
315
|
-
# the task is attempted.
|
|
352
|
+
# {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} is
|
|
353
|
+
# invalid, then the task will be sent to the default version of the default
|
|
354
|
+
# service when the task is attempted.
|
|
316
355
|
class AppEngineRouting; end
|
|
317
356
|
|
|
318
357
|
# The HTTP method used to execute the task.
|