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