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
|
@@ -44,14 +44,15 @@ module Google
|
|
|
44
44
|
# Creates a queue.
|
|
45
45
|
#
|
|
46
46
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
47
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
48
|
-
# it was dispatched or not.
|
|
47
|
+
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
48
|
+
# whether it was dispatched or not.
|
|
49
49
|
#
|
|
50
50
|
# WARNING: Using this method may have unintended side effects if you are
|
|
51
51
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
52
52
|
# Read
|
|
53
|
-
# [Overview of Queue Management and
|
|
54
|
-
# before using
|
|
53
|
+
# [Overview of Queue Management and
|
|
54
|
+
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
|
55
|
+
# this method.
|
|
55
56
|
rpc :CreateQueue, CreateQueueRequest, Queue
|
|
56
57
|
# Updates a queue.
|
|
57
58
|
#
|
|
@@ -59,14 +60,15 @@ module Google
|
|
|
59
60
|
# the queue if it does exist.
|
|
60
61
|
#
|
|
61
62
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
62
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
63
|
-
# it was dispatched or not.
|
|
63
|
+
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
64
|
+
# whether it was dispatched or not.
|
|
64
65
|
#
|
|
65
66
|
# WARNING: Using this method may have unintended side effects if you are
|
|
66
67
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
67
68
|
# Read
|
|
68
|
-
# [Overview of Queue Management and
|
|
69
|
-
# before using
|
|
69
|
+
# [Overview of Queue Management and
|
|
70
|
+
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
|
71
|
+
# this method.
|
|
70
72
|
rpc :UpdateQueue, UpdateQueueRequest, Queue
|
|
71
73
|
# Deletes a queue.
|
|
72
74
|
#
|
|
@@ -78,8 +80,9 @@ module Google
|
|
|
78
80
|
# WARNING: Using this method may have unintended side effects if you are
|
|
79
81
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
80
82
|
# Read
|
|
81
|
-
# [Overview of Queue Management and
|
|
82
|
-
# before using
|
|
83
|
+
# [Overview of Queue Management and
|
|
84
|
+
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
|
85
|
+
# this method.
|
|
83
86
|
rpc :DeleteQueue, DeleteQueueRequest, Google::Protobuf::Empty
|
|
84
87
|
# Purges a queue by deleting all of its tasks.
|
|
85
88
|
#
|
|
@@ -92,26 +95,30 @@ module Google
|
|
|
92
95
|
#
|
|
93
96
|
# If a queue is paused then the system will stop dispatching tasks
|
|
94
97
|
# until the queue is resumed via
|
|
95
|
-
# [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can
|
|
96
|
-
# when the queue is paused. A queue is paused if its
|
|
97
|
-
# [state][google.cloud.tasks.v2beta2.Queue.state] is
|
|
98
|
+
# [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can
|
|
99
|
+
# still be added when the queue is paused. A queue is paused if its
|
|
100
|
+
# [state][google.cloud.tasks.v2beta2.Queue.state] is
|
|
101
|
+
# [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
|
|
98
102
|
rpc :PauseQueue, PauseQueueRequest, Queue
|
|
99
103
|
# Resume a queue.
|
|
100
104
|
#
|
|
101
105
|
# This method resumes a queue after it has been
|
|
102
106
|
# [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or
|
|
103
|
-
# [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a
|
|
104
|
-
# in the queue's
|
|
105
|
-
#
|
|
107
|
+
# [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a
|
|
108
|
+
# queue is stored in the queue's
|
|
109
|
+
# [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method
|
|
110
|
+
# it will be set to
|
|
111
|
+
# [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING].
|
|
106
112
|
#
|
|
107
113
|
# WARNING: Resuming many high-QPS queues at the same time can
|
|
108
114
|
# lead to target overloading. If you are resuming high-QPS
|
|
109
115
|
# queues, follow the 500/50/5 pattern described in
|
|
110
|
-
# [Managing Cloud Tasks Scaling
|
|
116
|
+
# [Managing Cloud Tasks Scaling
|
|
117
|
+
# Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
|
111
118
|
rpc :ResumeQueue, ResumeQueueRequest, Queue
|
|
112
|
-
# Gets the access control policy for a
|
|
113
|
-
# Returns an empty policy if the
|
|
114
|
-
# set.
|
|
119
|
+
# Gets the access control policy for a
|
|
120
|
+
# [Queue][google.cloud.tasks.v2beta2.Queue]. Returns an empty policy if the
|
|
121
|
+
# resource exists and does not have a policy set.
|
|
115
122
|
#
|
|
116
123
|
# Authorization requires the following
|
|
117
124
|
# [Google IAM](https://cloud.google.com/iam) permission on the specified
|
|
@@ -119,8 +126,8 @@ module Google
|
|
|
119
126
|
#
|
|
120
127
|
# * `cloudtasks.queues.getIamPolicy`
|
|
121
128
|
rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
|
|
122
|
-
# Sets the access control policy for a
|
|
123
|
-
# policy.
|
|
129
|
+
# Sets the access control policy for a
|
|
130
|
+
# [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing policy.
|
|
124
131
|
#
|
|
125
132
|
# Note: The Cloud Console does not check queue-level IAM permissions yet.
|
|
126
133
|
# Project-level permissions are required to use the Cloud Console.
|
|
@@ -131,9 +138,10 @@ module Google
|
|
|
131
138
|
#
|
|
132
139
|
# * `cloudtasks.queues.setIamPolicy`
|
|
133
140
|
rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
|
|
134
|
-
# Returns permissions that a caller has on a
|
|
135
|
-
# If the resource does not exist,
|
|
136
|
-
# permissions, not a
|
|
141
|
+
# Returns permissions that a caller has on a
|
|
142
|
+
# [Queue][google.cloud.tasks.v2beta2.Queue]. If the resource does not exist,
|
|
143
|
+
# this will return an empty set of permissions, not a
|
|
144
|
+
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
|
|
137
145
|
#
|
|
138
146
|
# Note: This operation is designed to be used for building permission-aware
|
|
139
147
|
# UIs and command-line tools, not for authorization checking. This operation
|
|
@@ -141,10 +149,10 @@ module Google
|
|
|
141
149
|
rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
|
|
142
150
|
# Lists the tasks in a queue.
|
|
143
151
|
#
|
|
144
|
-
# By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]
|
|
145
|
-
# due to performance considerations;
|
|
146
|
-
# [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view]
|
|
147
|
-
# subset of information which is returned.
|
|
152
|
+
# By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]
|
|
153
|
+
# view is retrieved due to performance considerations;
|
|
154
|
+
# [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view]
|
|
155
|
+
# controls the subset of information which is returned.
|
|
148
156
|
#
|
|
149
157
|
# The tasks may be returned in any order. The ordering may change at any
|
|
150
158
|
# time.
|
|
@@ -155,9 +163,11 @@ module Google
|
|
|
155
163
|
#
|
|
156
164
|
# Tasks cannot be updated after creation; there is no UpdateTask command.
|
|
157
165
|
#
|
|
158
|
-
# * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget],
|
|
166
|
+
# * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget],
|
|
167
|
+
# the maximum task size is
|
|
159
168
|
# 100KB.
|
|
160
|
-
# * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum
|
|
169
|
+
# * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum
|
|
170
|
+
# task size is 1MB.
|
|
161
171
|
rpc :CreateTask, CreateTaskRequest, Task
|
|
162
172
|
# Deletes a task.
|
|
163
173
|
#
|
|
@@ -170,18 +180,19 @@ module Google
|
|
|
170
180
|
#
|
|
171
181
|
# This method is invoked by the worker to obtain a lease. The
|
|
172
182
|
# worker must acknowledge the task via
|
|
173
|
-
# [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask]
|
|
174
|
-
# performed the work associated with the task.
|
|
175
|
-
#
|
|
176
|
-
# The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended
|
|
177
|
-
# the worker needs to perform the work associated with the
|
|
178
|
-
# return the payloads in the
|
|
179
|
-
# [
|
|
180
|
-
# [
|
|
181
|
-
#
|
|
182
|
-
#
|
|
183
|
-
#
|
|
184
|
-
#
|
|
183
|
+
# [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask]
|
|
184
|
+
# after they have performed the work associated with the task.
|
|
185
|
+
#
|
|
186
|
+
# The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended
|
|
187
|
+
# to store data that the worker needs to perform the work associated with the
|
|
188
|
+
# task. To return the payloads in the
|
|
189
|
+
# [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set
|
|
190
|
+
# [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view]
|
|
191
|
+
# to [FULL][google.cloud.tasks.v2beta2.Task.View.FULL].
|
|
192
|
+
#
|
|
193
|
+
# A maximum of 10 qps of
|
|
194
|
+
# [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests are
|
|
195
|
+
# allowed per queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
|
|
185
196
|
# is returned when this limit is
|
|
186
197
|
# exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
|
|
187
198
|
# is also returned when
|
|
@@ -191,12 +202,13 @@ module Google
|
|
|
191
202
|
# Acknowledges a pull task.
|
|
192
203
|
#
|
|
193
204
|
# The worker, that is, the entity that
|
|
194
|
-
# [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must
|
|
195
|
-
# to indicate that the work associated with the task has
|
|
205
|
+
# [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must
|
|
206
|
+
# call this method to indicate that the work associated with the task has
|
|
207
|
+
# finished.
|
|
196
208
|
#
|
|
197
209
|
# The worker must acknowledge a task within the
|
|
198
|
-
# [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]
|
|
199
|
-
# will expire and the task will become available to be leased
|
|
210
|
+
# [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]
|
|
211
|
+
# or the lease will expire and the task will become available to be leased
|
|
200
212
|
# again. After the task is acknowledged, it will not be returned
|
|
201
213
|
# by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks],
|
|
202
214
|
# [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or
|
|
@@ -206,42 +218,46 @@ module Google
|
|
|
206
218
|
#
|
|
207
219
|
# The worker can use this method to extend the lease by a new
|
|
208
220
|
# duration, starting from now. The new task lease will be
|
|
209
|
-
# returned in the task's
|
|
221
|
+
# returned in the task's
|
|
222
|
+
# [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
|
|
210
223
|
rpc :RenewLease, RenewLeaseRequest, Task
|
|
211
224
|
# Cancel a pull task's lease.
|
|
212
225
|
#
|
|
213
226
|
# The worker can use this method to cancel a task's lease by
|
|
214
|
-
# setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]
|
|
215
|
-
# make the task available to be leased to the next caller
|
|
216
|
-
# [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
|
|
227
|
+
# setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]
|
|
228
|
+
# to now. This will make the task available to be leased to the next caller
|
|
229
|
+
# of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
|
|
217
230
|
rpc :CancelLease, CancelLeaseRequest, Task
|
|
218
231
|
# Forces a task to run now.
|
|
219
232
|
#
|
|
220
233
|
# When this method is called, Cloud Tasks will dispatch the task, even if
|
|
221
|
-
# the task is already running, the queue has reached its
|
|
222
|
-
#
|
|
234
|
+
# the task is already running, the queue has reached its
|
|
235
|
+
# [RateLimits][google.cloud.tasks.v2beta2.RateLimits] or is
|
|
236
|
+
# [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
|
|
223
237
|
#
|
|
224
238
|
# This command is meant to be used for manual debugging. For
|
|
225
|
-
# example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be
|
|
226
|
-
# task after a fix has been made or to manually force
|
|
227
|
-
# dispatched now.
|
|
239
|
+
# example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be
|
|
240
|
+
# used to retry a failed task after a fix has been made or to manually force
|
|
241
|
+
# a task to be dispatched now.
|
|
228
242
|
#
|
|
229
243
|
# The dispatched task is returned. That is, the task that is returned
|
|
230
|
-
# contains the [status][google.cloud.tasks.v2beta2.Task.status] after the
|
|
231
|
-
# before the task is received by its target.
|
|
244
|
+
# contains the [status][google.cloud.tasks.v2beta2.Task.status] after the
|
|
245
|
+
# task is dispatched but before the task is received by its target.
|
|
232
246
|
#
|
|
233
247
|
# If Cloud Tasks receives a successful response from the task's
|
|
234
248
|
# target, then the task will be deleted; otherwise the task's
|
|
235
|
-
# [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be
|
|
236
|
-
#
|
|
237
|
-
#
|
|
249
|
+
# [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be
|
|
250
|
+
# reset to the time that
|
|
251
|
+
# [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus
|
|
252
|
+
# the retry delay specified in the queue's
|
|
253
|
+
# [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig].
|
|
238
254
|
#
|
|
239
255
|
# [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns
|
|
240
256
|
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
|
|
241
257
|
# task that has already succeeded or permanently failed.
|
|
242
258
|
#
|
|
243
|
-
# [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called
|
|
244
|
-
# [pull task][google.cloud.tasks.v2beta2.PullMessage].
|
|
259
|
+
# [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called
|
|
260
|
+
# on a [pull task][google.cloud.tasks.v2beta2.PullMessage].
|
|
245
261
|
rpc :RunTask, RunTaskRequest, Task
|
|
246
262
|
end
|
|
247
263
|
|
|
@@ -17,7 +17,8 @@ module Google
|
|
|
17
17
|
module Cloud
|
|
18
18
|
module Tasks
|
|
19
19
|
module V2beta2
|
|
20
|
-
# Request message for
|
|
20
|
+
# Request message for
|
|
21
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListQueues ListQueues}.
|
|
21
22
|
# @!attribute [rw] parent
|
|
22
23
|
# @return [String]
|
|
23
24
|
# Required.
|
|
@@ -26,11 +27,11 @@ module Google
|
|
|
26
27
|
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
|
27
28
|
# @!attribute [rw] filter
|
|
28
29
|
# @return [String]
|
|
29
|
-
# `filter` can be used to specify a subset of queues. Any
|
|
30
|
-
# field can be used as a filter and
|
|
31
|
-
# For example: `<=, <, >=, >, !=, =, :`. The
|
|
32
|
-
# described in
|
|
33
|
-
#
|
|
30
|
+
# `filter` can be used to specify a subset of queues. Any
|
|
31
|
+
# {Google::Cloud::Tasks::V2beta2::Queue Queue} field can be used as a filter and
|
|
32
|
+
# several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
|
|
33
|
+
# filter syntax is the same as described in [Stackdriver's Advanced Logs
|
|
34
|
+
# Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
|
|
34
35
|
#
|
|
35
36
|
# Sample filter "app_engine_http_target: *".
|
|
36
37
|
#
|
|
@@ -43,21 +44,24 @@ module Google
|
|
|
43
44
|
# The maximum page size is 9800. If unspecified, the page size will
|
|
44
45
|
# be the maximum. Fewer queues than requested might be returned,
|
|
45
46
|
# even if more queues exist; use the
|
|
46
|
-
# {Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
|
|
47
|
-
# response to determine if more queues exist.
|
|
47
|
+
# {Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
|
|
48
|
+
# in the response to determine if more queues exist.
|
|
48
49
|
# @!attribute [rw] page_token
|
|
49
50
|
# @return [String]
|
|
50
51
|
# A token identifying the page of results to return.
|
|
51
52
|
#
|
|
52
53
|
# To request the first page results, page_token must be empty. To
|
|
53
54
|
# request the next page of results, page_token must be the value of
|
|
54
|
-
# {Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
|
|
55
|
-
# from the previous call to
|
|
56
|
-
# method. It
|
|
57
|
-
#
|
|
55
|
+
# {Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
|
|
56
|
+
# returned from the previous call to
|
|
57
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListQueues ListQueues} method. It
|
|
58
|
+
# is an error to switch the value of the
|
|
59
|
+
# {Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while
|
|
60
|
+
# iterating through pages.
|
|
58
61
|
class ListQueuesRequest; end
|
|
59
62
|
|
|
60
|
-
# Response message for
|
|
63
|
+
# Response message for
|
|
64
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListQueues ListQueues}.
|
|
61
65
|
# @!attribute [rw] queues
|
|
62
66
|
# @return [Array<Google::Cloud::Tasks::V2beta2::Queue>]
|
|
63
67
|
# The list of queues.
|
|
@@ -66,7 +70,8 @@ module Google
|
|
|
66
70
|
# A token to retrieve next page of results.
|
|
67
71
|
#
|
|
68
72
|
# To return the next page of results, call
|
|
69
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListQueues ListQueues} with this
|
|
73
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListQueues ListQueues} with this
|
|
74
|
+
# value as the
|
|
70
75
|
# {Google::Cloud::Tasks::V2beta2::ListQueuesRequest#page_token page_token}.
|
|
71
76
|
#
|
|
72
77
|
# If the next_page_token is empty, there are no more results.
|
|
@@ -74,7 +79,8 @@ module Google
|
|
|
74
79
|
# The page token is valid for only 2 hours.
|
|
75
80
|
class ListQueuesResponse; end
|
|
76
81
|
|
|
77
|
-
# Request message for
|
|
82
|
+
# Request message for
|
|
83
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::GetQueue GetQueue}.
|
|
78
84
|
# @!attribute [rw] name
|
|
79
85
|
# @return [String]
|
|
80
86
|
# Required.
|
|
@@ -83,7 +89,8 @@ module Google
|
|
|
83
89
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
|
84
90
|
class GetQueueRequest; end
|
|
85
91
|
|
|
86
|
-
# Request message for
|
|
92
|
+
# Request message for
|
|
93
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateQueue CreateQueue}.
|
|
87
94
|
# @!attribute [rw] parent
|
|
88
95
|
# @return [String]
|
|
89
96
|
# Required.
|
|
@@ -100,21 +107,25 @@ module Google
|
|
|
100
107
|
#
|
|
101
108
|
# The queue to create.
|
|
102
109
|
#
|
|
103
|
-
# {Google::Cloud::Tasks::V2beta2::Queue#name Queue's name} cannot be the same as
|
|
110
|
+
# {Google::Cloud::Tasks::V2beta2::Queue#name Queue's name} cannot be the same as
|
|
111
|
+
# an existing queue.
|
|
104
112
|
class CreateQueueRequest; end
|
|
105
113
|
|
|
106
|
-
# Request message for
|
|
114
|
+
# Request message for
|
|
115
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::UpdateQueue UpdateQueue}.
|
|
107
116
|
# @!attribute [rw] queue
|
|
108
117
|
# @return [Google::Cloud::Tasks::V2beta2::Queue]
|
|
109
118
|
# Required.
|
|
110
119
|
#
|
|
111
120
|
# The queue to create or update.
|
|
112
121
|
#
|
|
113
|
-
# The queue's {Google::Cloud::Tasks::V2beta2::Queue#name name} must be
|
|
122
|
+
# The queue's {Google::Cloud::Tasks::V2beta2::Queue#name name} must be
|
|
123
|
+
# specified.
|
|
114
124
|
#
|
|
115
125
|
# Output only fields cannot be modified using UpdateQueue.
|
|
116
126
|
# Any value specified for an output only field will be ignored.
|
|
117
|
-
# The queue's {Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be
|
|
127
|
+
# The queue's {Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be
|
|
128
|
+
# changed.
|
|
118
129
|
# @!attribute [rw] update_mask
|
|
119
130
|
# @return [Google::Protobuf::FieldMask]
|
|
120
131
|
# A mask used to specify which fields of the queue are being updated.
|
|
@@ -122,7 +133,8 @@ module Google
|
|
|
122
133
|
# If empty, then all fields will be updated.
|
|
123
134
|
class UpdateQueueRequest; end
|
|
124
135
|
|
|
125
|
-
# Request message for
|
|
136
|
+
# Request message for
|
|
137
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue DeleteQueue}.
|
|
126
138
|
# @!attribute [rw] name
|
|
127
139
|
# @return [String]
|
|
128
140
|
# Required.
|
|
@@ -131,7 +143,8 @@ module Google
|
|
|
131
143
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
|
132
144
|
class DeleteQueueRequest; end
|
|
133
145
|
|
|
134
|
-
# Request message for
|
|
146
|
+
# Request message for
|
|
147
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::PurgeQueue PurgeQueue}.
|
|
135
148
|
# @!attribute [rw] name
|
|
136
149
|
# @return [String]
|
|
137
150
|
# Required.
|
|
@@ -140,7 +153,8 @@ module Google
|
|
|
140
153
|
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
|
141
154
|
class PurgeQueueRequest; end
|
|
142
155
|
|
|
143
|
-
# Request message for
|
|
156
|
+
# Request message for
|
|
157
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::PauseQueue PauseQueue}.
|
|
144
158
|
# @!attribute [rw] name
|
|
145
159
|
# @return [String]
|
|
146
160
|
# Required.
|
|
@@ -149,7 +163,8 @@ module Google
|
|
|
149
163
|
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
|
150
164
|
class PauseQueueRequest; end
|
|
151
165
|
|
|
152
|
-
# Request message for
|
|
166
|
+
# Request message for
|
|
167
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ResumeQueue ResumeQueue}.
|
|
153
168
|
# @!attribute [rw] name
|
|
154
169
|
# @return [String]
|
|
155
170
|
# Required.
|
|
@@ -158,7 +173,8 @@ module Google
|
|
|
158
173
|
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
|
159
174
|
class ResumeQueueRequest; end
|
|
160
175
|
|
|
161
|
-
# Request message for listing tasks using
|
|
176
|
+
# Request message for listing tasks using
|
|
177
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListTasks ListTasks}.
|
|
162
178
|
# @!attribute [rw] parent
|
|
163
179
|
# @return [String]
|
|
164
180
|
# Required.
|
|
@@ -167,18 +183,19 @@ module Google
|
|
|
167
183
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
|
168
184
|
# @!attribute [rw] response_view
|
|
169
185
|
# @return [Google::Cloud::Tasks::V2beta2::Task::View]
|
|
170
|
-
# The response_view specifies which subset of the
|
|
171
|
-
# returned.
|
|
172
|
-
#
|
|
173
|
-
# By default response_view is
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
#
|
|
177
|
-
# contains.
|
|
178
|
-
#
|
|
179
|
-
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
180
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
181
|
-
# permission on the
|
|
186
|
+
# The response_view specifies which subset of the
|
|
187
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
188
|
+
#
|
|
189
|
+
# By default response_view is
|
|
190
|
+
# {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
191
|
+
# retrieved by default because some data, such as payloads, might be
|
|
192
|
+
# desirable to return only when needed because of its large size or because
|
|
193
|
+
# of the sensitivity of data that it contains.
|
|
194
|
+
#
|
|
195
|
+
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
196
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
197
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
198
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
182
199
|
# @!attribute [rw] page_size
|
|
183
200
|
# @return [Integer]
|
|
184
201
|
# Requested page size. Fewer tasks than requested might be returned.
|
|
@@ -186,22 +203,23 @@ module Google
|
|
|
186
203
|
# The maximum page size is 1000. If unspecified, the page size will
|
|
187
204
|
# be the maximum. Fewer tasks than requested might be returned,
|
|
188
205
|
# even if more tasks exist; use
|
|
189
|
-
# {Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
|
|
190
|
-
# response to determine if more tasks exist.
|
|
206
|
+
# {Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
|
|
207
|
+
# in the response to determine if more tasks exist.
|
|
191
208
|
# @!attribute [rw] page_token
|
|
192
209
|
# @return [String]
|
|
193
210
|
# A token identifying the page of results to return.
|
|
194
211
|
#
|
|
195
212
|
# To request the first page results, page_token must be empty. To
|
|
196
213
|
# request the next page of results, page_token must be the value of
|
|
197
|
-
# {Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
|
|
198
|
-
# from the previous call to
|
|
199
|
-
# method.
|
|
214
|
+
# {Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
|
|
215
|
+
# returned from the previous call to
|
|
216
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListTasks ListTasks} method.
|
|
200
217
|
#
|
|
201
218
|
# The page token is valid for only 2 hours.
|
|
202
219
|
class ListTasksRequest; end
|
|
203
220
|
|
|
204
|
-
# Response message for listing tasks using
|
|
221
|
+
# Response message for listing tasks using
|
|
222
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListTasks ListTasks}.
|
|
205
223
|
# @!attribute [rw] tasks
|
|
206
224
|
# @return [Array<Google::Cloud::Tasks::V2beta2::Task>]
|
|
207
225
|
# The list of tasks.
|
|
@@ -210,13 +228,15 @@ module Google
|
|
|
210
228
|
# A token to retrieve next page of results.
|
|
211
229
|
#
|
|
212
230
|
# To return the next page of results, call
|
|
213
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListTasks ListTasks} with this
|
|
231
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::ListTasks ListTasks} with this
|
|
232
|
+
# value as the
|
|
214
233
|
# {Google::Cloud::Tasks::V2beta2::ListTasksRequest#page_token page_token}.
|
|
215
234
|
#
|
|
216
235
|
# If the next_page_token is empty, there are no more results.
|
|
217
236
|
class ListTasksResponse; end
|
|
218
237
|
|
|
219
|
-
# Request message for getting a task using
|
|
238
|
+
# Request message for getting a task using
|
|
239
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::GetTask GetTask}.
|
|
220
240
|
# @!attribute [rw] name
|
|
221
241
|
# @return [String]
|
|
222
242
|
# Required.
|
|
@@ -225,21 +245,23 @@ module Google
|
|
|
225
245
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
|
226
246
|
# @!attribute [rw] response_view
|
|
227
247
|
# @return [Google::Cloud::Tasks::V2beta2::Task::View]
|
|
228
|
-
# The response_view specifies which subset of the
|
|
229
|
-
# returned.
|
|
230
|
-
#
|
|
231
|
-
# By default response_view is
|
|
232
|
-
#
|
|
233
|
-
#
|
|
234
|
-
#
|
|
235
|
-
# contains.
|
|
236
|
-
#
|
|
237
|
-
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
238
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
239
|
-
# permission on the
|
|
248
|
+
# The response_view specifies which subset of the
|
|
249
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
250
|
+
#
|
|
251
|
+
# By default response_view is
|
|
252
|
+
# {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
253
|
+
# retrieved by default because some data, such as payloads, might be
|
|
254
|
+
# desirable to return only when needed because of its large size or because
|
|
255
|
+
# of the sensitivity of data that it contains.
|
|
256
|
+
#
|
|
257
|
+
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
258
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
259
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
260
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
240
261
|
class GetTaskRequest; end
|
|
241
262
|
|
|
242
|
-
# Request message for
|
|
263
|
+
# Request message for
|
|
264
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask CreateTask}.
|
|
243
265
|
# @!attribute [rw] parent
|
|
244
266
|
# @return [String]
|
|
245
267
|
# Required.
|
|
@@ -256,13 +278,13 @@ module Google
|
|
|
256
278
|
#
|
|
257
279
|
# Task names have the following format:
|
|
258
280
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
|
|
259
|
-
# The user can optionally specify a task
|
|
260
|
-
# name
|
|
261
|
-
# unique task id, which will be set in
|
|
262
|
-
# {Google::Cloud::Tasks::V2beta2::Task#name response}.
|
|
281
|
+
# The user can optionally specify a task
|
|
282
|
+
# {Google::Cloud::Tasks::V2beta2::Task#name name}. If a name is not specified
|
|
283
|
+
# then the system will generate a random unique task id, which will be set in
|
|
284
|
+
# the task returned in the {Google::Cloud::Tasks::V2beta2::Task#name response}.
|
|
263
285
|
#
|
|
264
|
-
# If {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not
|
|
265
|
-
# past then Cloud Tasks will set it to the current time.
|
|
286
|
+
# If {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not
|
|
287
|
+
# set or is in the past then Cloud Tasks will set it to the current time.
|
|
266
288
|
#
|
|
267
289
|
# Task De-duplication:
|
|
268
290
|
#
|
|
@@ -277,28 +299,29 @@ module Google
|
|
|
277
299
|
# for ~9days after the original task was deleted or completed.
|
|
278
300
|
#
|
|
279
301
|
# Because there is an extra lookup cost to identify duplicate task
|
|
280
|
-
# names, these {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask CreateTask}
|
|
281
|
-
# increased latency. Using hashed strings for the
|
|
282
|
-
# the prefix of the task id is recommended. Choosing task ids
|
|
283
|
-
# are sequential or have sequential prefixes, for example using a
|
|
302
|
+
# names, these {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask CreateTask}
|
|
303
|
+
# calls have significantly increased latency. Using hashed strings for the
|
|
304
|
+
# task id or for the prefix of the task id is recommended. Choosing task ids
|
|
305
|
+
# that are sequential or have sequential prefixes, for example using a
|
|
284
306
|
# timestamp, causes an increase in latency and error rates in all
|
|
285
307
|
# task commands. The infrastructure relies on an approximately
|
|
286
308
|
# uniform distribution of task ids to store and serve tasks
|
|
287
309
|
# efficiently.
|
|
288
310
|
# @!attribute [rw] response_view
|
|
289
311
|
# @return [Google::Cloud::Tasks::V2beta2::Task::View]
|
|
290
|
-
# The response_view specifies which subset of the
|
|
291
|
-
# returned.
|
|
292
|
-
#
|
|
293
|
-
# By default response_view is
|
|
294
|
-
#
|
|
295
|
-
#
|
|
296
|
-
#
|
|
297
|
-
# contains.
|
|
298
|
-
#
|
|
299
|
-
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
300
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
301
|
-
# permission on the
|
|
312
|
+
# The response_view specifies which subset of the
|
|
313
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
314
|
+
#
|
|
315
|
+
# By default response_view is
|
|
316
|
+
# {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
317
|
+
# retrieved by default because some data, such as payloads, might be
|
|
318
|
+
# desirable to return only when needed because of its large size or because
|
|
319
|
+
# of the sensitivity of data that it contains.
|
|
320
|
+
#
|
|
321
|
+
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
322
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
323
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
324
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
302
325
|
class CreateTaskRequest; end
|
|
303
326
|
|
|
304
327
|
# Request message for deleting a task using
|
|
@@ -311,7 +334,8 @@ module Google
|
|
|
311
334
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
|
312
335
|
class DeleteTaskRequest; end
|
|
313
336
|
|
|
314
|
-
# Request message for leasing tasks using
|
|
337
|
+
# Request message for leasing tasks using
|
|
338
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks}.
|
|
315
339
|
# @!attribute [rw] parent
|
|
316
340
|
# @return [String]
|
|
317
341
|
# Required.
|
|
@@ -330,39 +354,42 @@ module Google
|
|
|
330
354
|
# @return [Google::Protobuf::Duration]
|
|
331
355
|
# After the worker has successfully finished the work associated
|
|
332
356
|
# with the task, the worker must call via
|
|
333
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::AcknowledgeTask AcknowledgeTask}
|
|
334
|
-
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
|
|
335
|
-
# returned to a later
|
|
336
|
-
#
|
|
357
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::AcknowledgeTask AcknowledgeTask}
|
|
358
|
+
# before the {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
|
|
359
|
+
# Otherwise the task will be returned to a later
|
|
360
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} call so that
|
|
361
|
+
# another worker can retry it.
|
|
337
362
|
#
|
|
338
363
|
# The maximum lease duration is 1 week.
|
|
339
364
|
# `lease_duration` will be truncated to the nearest second.
|
|
340
365
|
# @!attribute [rw] response_view
|
|
341
366
|
# @return [Google::Cloud::Tasks::V2beta2::Task::View]
|
|
342
|
-
# The response_view specifies which subset of the
|
|
343
|
-
# returned.
|
|
344
|
-
#
|
|
345
|
-
# By default response_view is
|
|
346
|
-
#
|
|
347
|
-
#
|
|
348
|
-
#
|
|
349
|
-
# contains.
|
|
350
|
-
#
|
|
351
|
-
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
352
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
353
|
-
# permission on the
|
|
367
|
+
# The response_view specifies which subset of the
|
|
368
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
369
|
+
#
|
|
370
|
+
# By default response_view is
|
|
371
|
+
# {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
372
|
+
# retrieved by default because some data, such as payloads, might be
|
|
373
|
+
# desirable to return only when needed because of its large size or because
|
|
374
|
+
# of the sensitivity of data that it contains.
|
|
375
|
+
#
|
|
376
|
+
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
377
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
378
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
379
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
354
380
|
# @!attribute [rw] filter
|
|
355
381
|
# @return [String]
|
|
356
382
|
# `filter` can be used to specify a subset of tasks to lease.
|
|
357
383
|
#
|
|
358
384
|
# When `filter` is set to `tag=<my-tag>` then the
|
|
359
|
-
# {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only
|
|
360
|
-
# {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to
|
|
361
|
-
# less than 500 characters.
|
|
385
|
+
# {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only
|
|
386
|
+
# tasks whose {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to
|
|
387
|
+
# `<my-tag>`. `<my-tag>` must be less than 500 characters.
|
|
362
388
|
#
|
|
363
389
|
# When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
|
|
364
390
|
# the same tag as the task with the oldest
|
|
365
|
-
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
|
|
391
|
+
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
|
|
392
|
+
# returned.
|
|
366
393
|
#
|
|
367
394
|
# Grammar Syntax:
|
|
368
395
|
#
|
|
@@ -380,11 +407,13 @@ module Google
|
|
|
380
407
|
# [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
|
|
381
408
|
# only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
|
|
382
409
|
# aren't UTF-8 encoded can't be used in the
|
|
383
|
-
# {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the
|
|
384
|
-
# {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed
|
|
410
|
+
# {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the
|
|
411
|
+
# task's {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed
|
|
412
|
+
# as empty in Cloud Tasks.
|
|
385
413
|
class LeaseTasksRequest; end
|
|
386
414
|
|
|
387
|
-
# Response message for leasing tasks using
|
|
415
|
+
# Response message for leasing tasks using
|
|
416
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks}.
|
|
388
417
|
# @!attribute [rw] tasks
|
|
389
418
|
# @return [Array<Google::Cloud::Tasks::V2beta2::Task>]
|
|
390
419
|
# The leased tasks.
|
|
@@ -405,8 +434,8 @@ module Google
|
|
|
405
434
|
# The task's current schedule time, available in the
|
|
406
435
|
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
|
|
407
436
|
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} response or
|
|
408
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response.
|
|
409
|
-
# to ensure that your worker currently holds the lease.
|
|
437
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response.
|
|
438
|
+
# This restriction is to ensure that your worker currently holds the lease.
|
|
410
439
|
class AcknowledgeTaskRequest; end
|
|
411
440
|
|
|
412
441
|
# Request message for renewing a lease using
|
|
@@ -424,8 +453,8 @@ module Google
|
|
|
424
453
|
# The task's current schedule time, available in the
|
|
425
454
|
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
|
|
426
455
|
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} response or
|
|
427
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response.
|
|
428
|
-
# to ensure that your worker currently holds the lease.
|
|
456
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response.
|
|
457
|
+
# This restriction is to ensure that your worker currently holds the lease.
|
|
429
458
|
# @!attribute [rw] lease_duration
|
|
430
459
|
# @return [Google::Protobuf::Duration]
|
|
431
460
|
# Required.
|
|
@@ -437,18 +466,19 @@ module Google
|
|
|
437
466
|
# `lease_duration` will be truncated to the nearest second.
|
|
438
467
|
# @!attribute [rw] response_view
|
|
439
468
|
# @return [Google::Cloud::Tasks::V2beta2::Task::View]
|
|
440
|
-
# The response_view specifies which subset of the
|
|
441
|
-
# returned.
|
|
442
|
-
#
|
|
443
|
-
# By default response_view is
|
|
444
|
-
#
|
|
445
|
-
#
|
|
446
|
-
#
|
|
447
|
-
# contains.
|
|
448
|
-
#
|
|
449
|
-
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
450
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
451
|
-
# permission on the
|
|
469
|
+
# The response_view specifies which subset of the
|
|
470
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
471
|
+
#
|
|
472
|
+
# By default response_view is
|
|
473
|
+
# {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
474
|
+
# retrieved by default because some data, such as payloads, might be
|
|
475
|
+
# desirable to return only when needed because of its large size or because
|
|
476
|
+
# of the sensitivity of data that it contains.
|
|
477
|
+
#
|
|
478
|
+
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
479
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
480
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
481
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
452
482
|
class RenewLeaseRequest; end
|
|
453
483
|
|
|
454
484
|
# Request message for canceling a lease using
|
|
@@ -466,22 +496,23 @@ module Google
|
|
|
466
496
|
# The task's current schedule time, available in the
|
|
467
497
|
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
|
|
468
498
|
# {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} response or
|
|
469
|
-
# {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response.
|
|
470
|
-
# to ensure that your worker currently holds the lease.
|
|
499
|
+
# {Google::Cloud::Tasks::V2beta2::CloudTasks::RenewLease RenewLease} response.
|
|
500
|
+
# This restriction is to ensure that your worker currently holds the lease.
|
|
471
501
|
# @!attribute [rw] response_view
|
|
472
502
|
# @return [Google::Cloud::Tasks::V2beta2::Task::View]
|
|
473
|
-
# The response_view specifies which subset of the
|
|
474
|
-
# returned.
|
|
475
|
-
#
|
|
476
|
-
# By default response_view is
|
|
477
|
-
#
|
|
478
|
-
#
|
|
479
|
-
#
|
|
480
|
-
# contains.
|
|
481
|
-
#
|
|
482
|
-
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
483
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
484
|
-
# permission on the
|
|
503
|
+
# The response_view specifies which subset of the
|
|
504
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
505
|
+
#
|
|
506
|
+
# By default response_view is
|
|
507
|
+
# {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
508
|
+
# retrieved by default because some data, such as payloads, might be
|
|
509
|
+
# desirable to return only when needed because of its large size or because
|
|
510
|
+
# of the sensitivity of data that it contains.
|
|
511
|
+
#
|
|
512
|
+
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
513
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
514
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
515
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
485
516
|
class CancelLeaseRequest; end
|
|
486
517
|
|
|
487
518
|
# Request message for forcing a task to run now using
|
|
@@ -494,18 +525,19 @@ module Google
|
|
|
494
525
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
|
495
526
|
# @!attribute [rw] response_view
|
|
496
527
|
# @return [Google::Cloud::Tasks::V2beta2::Task::View]
|
|
497
|
-
# The response_view specifies which subset of the
|
|
498
|
-
# returned.
|
|
499
|
-
#
|
|
500
|
-
# By default response_view is
|
|
501
|
-
#
|
|
502
|
-
#
|
|
503
|
-
#
|
|
504
|
-
# contains.
|
|
505
|
-
#
|
|
506
|
-
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
507
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
508
|
-
# permission on the
|
|
528
|
+
# The response_view specifies which subset of the
|
|
529
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
530
|
+
#
|
|
531
|
+
# By default response_view is
|
|
532
|
+
# {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
533
|
+
# retrieved by default because some data, such as payloads, might be
|
|
534
|
+
# desirable to return only when needed because of its large size or because
|
|
535
|
+
# of the sensitivity of data that it contains.
|
|
536
|
+
#
|
|
537
|
+
# Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
538
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
539
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
540
|
+
# {Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
509
541
|
class RunTaskRequest; end
|
|
510
542
|
end
|
|
511
543
|
end
|