google-cloud-tasks-v2beta2 0.7.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +1 -1
  3. data/README.md +3 -3
  4. data/lib/google/cloud/tasks/v2beta2/cloud_tasks/client.rb +227 -202
  5. data/lib/google/cloud/tasks/v2beta2/cloud_tasks/rest/client.rb +2249 -0
  6. data/lib/google/cloud/tasks/v2beta2/cloud_tasks/rest/service_stub.rb +1242 -0
  7. data/lib/google/cloud/tasks/v2beta2/cloud_tasks/rest.rb +53 -0
  8. data/lib/google/cloud/tasks/v2beta2/cloud_tasks.rb +7 -1
  9. data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +29 -87
  10. data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +68 -56
  11. data/lib/google/cloud/tasks/v2beta2/queue_pb.rb +27 -44
  12. data/lib/google/cloud/tasks/v2beta2/rest.rb +37 -0
  13. data/lib/google/cloud/tasks/v2beta2/target_pb.rb +23 -32
  14. data/lib/google/cloud/tasks/v2beta2/task_pb.rb +27 -30
  15. data/lib/google/cloud/tasks/v2beta2/version.rb +1 -1
  16. data/lib/google/cloud/tasks/v2beta2.rb +7 -2
  17. data/proto_docs/google/api/client.rb +381 -0
  18. data/proto_docs/google/api/launch_stage.rb +71 -0
  19. data/proto_docs/google/cloud/tasks/v2beta2/cloudtasks.rb +193 -159
  20. data/proto_docs/google/cloud/tasks/v2beta2/queue.rb +97 -73
  21. data/proto_docs/google/cloud/tasks/v2beta2/target.rb +88 -63
  22. data/proto_docs/google/cloud/tasks/v2beta2/task.rb +41 -24
  23. data/proto_docs/google/iam/v1/policy.rb +8 -4
  24. data/proto_docs/google/protobuf/any.rb +7 -4
  25. data/proto_docs/google/protobuf/empty.rb +0 -2
  26. data/proto_docs/google/protobuf/timestamp.rb +1 -3
  27. data/proto_docs/google/rpc/status.rb +4 -2
  28. metadata +14 -8
data/proto_docs/google/cloud/tasks/v2beta2/cloudtasks.rb CHANGED
@@ -21,18 +21,18 @@ module Google
21
21
  module Cloud
22
22
  module Tasks
23
23
  module V2beta2
24
- # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}.
24
+ # Request message for
25
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The location name.
28
29
  # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
29
30
  # @!attribute [rw] filter
30
31
  # @return [::String]
31
- # `filter` can be used to specify a subset of queues. Any {::Google::Cloud::Tasks::V2beta2::Queue Queue}
32
- # field can be used as a filter and several operators as supported.
33
- # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
34
- # described in
35
- # [Stackdriver's Advanced Logs
32
+ # `filter` can be used to specify a subset of queues. Any
33
+ # {::Google::Cloud::Tasks::V2beta2::Queue Queue} field can be used as a filter and
34
+ # several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
35
+ # filter syntax is the same as described in [Stackdriver's Advanced Logs
36
36
  # Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
37
37
  #
38
38
  # Sample filter "app_engine_http_target: *".
@@ -46,22 +46,24 @@ module Google
46
46
  # The maximum page size is 9800. If unspecified, the page size will
47
47
  # be the maximum. Fewer queues than requested might be returned,
48
48
  # even if more queues exist; use the
49
- # {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token} in the
50
- # response to determine if more queues exist.
49
+ # {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
50
+ # in the response to determine if more queues exist.
51
51
  # @!attribute [rw] page_token
52
52
  # @return [::String]
53
53
  # A token identifying the page of results to return.
54
54
  #
55
55
  # To request the first page results, page_token must be empty. To
56
56
  # request the next page of results, page_token must be the value of
57
- # {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token} returned
58
- # from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}
59
- # method. It is an error to switch the value of the
60
- # {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while iterating through pages.
57
+ # {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
58
+ # returned from the previous call to
59
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues} method. It
60
+ # is an error to switch the value of the
61
+ # {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while
62
+ # iterating through pages.
61
63
  # @!attribute [rw] read_mask
62
64
  # @return [::Google::Protobuf::FieldMask]
63
- # Optional. Read mask is used for a more granular control over what the API returns.
64
- # If the mask is not present all fields will be returned except
65
+ # Optional. Read mask is used for a more granular control over what the API
66
+ # returns. If the mask is not present all fields will be returned except
65
67
  # [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
66
68
  # specified in the mask.
67
69
  class ListQueuesRequest
@@ -69,7 +71,8 @@ module Google
69
71
  extend ::Google::Protobuf::MessageExts::ClassMethods
70
72
  end
71
73
 
72
- # Response message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}.
74
+ # Response message for
75
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}.
73
76
  # @!attribute [rw] queues
74
77
  # @return [::Array<::Google::Cloud::Tasks::V2beta2::Queue>]
75
78
  # The list of queues.
@@ -78,7 +81,8 @@ module Google
78
81
  # A token to retrieve next page of results.
79
82
  #
80
83
  # To return the next page of results, call
81
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues} with this value as the
84
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues} with this
85
+ # value as the
82
86
  # {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#page_token page_token}.
83
87
  #
84
88
  # If the next_page_token is empty, there are no more results.
@@ -89,15 +93,16 @@ module Google
89
93
  extend ::Google::Protobuf::MessageExts::ClassMethods
90
94
  end
91
95
 
92
- # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#get_queue GetQueue}.
96
+ # Request message for
97
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#get_queue GetQueue}.
93
98
  # @!attribute [rw] name
94
99
  # @return [::String]
95
100
  # Required. The resource name of the queue. For example:
96
101
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
97
102
  # @!attribute [rw] read_mask
98
103
  # @return [::Google::Protobuf::FieldMask]
99
- # Optional. Read mask is used for a more granular control over what the API returns.
100
- # If the mask is not present all fields will be returned except
104
+ # Optional. Read mask is used for a more granular control over what the API
105
+ # returns. If the mask is not present all fields will be returned except
101
106
  # [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
102
107
  # specified in the mask.
103
108
  class GetQueueRequest
@@ -105,7 +110,8 @@ module Google
105
110
  extend ::Google::Protobuf::MessageExts::ClassMethods
106
111
  end
107
112
 
108
- # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_queue CreateQueue}.
113
+ # Request message for
114
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_queue CreateQueue}.
109
115
  # @!attribute [rw] parent
110
116
  # @return [::String]
111
117
  # Required. The location name in which the queue will be created.
@@ -118,22 +124,26 @@ module Google
118
124
  # @return [::Google::Cloud::Tasks::V2beta2::Queue]
119
125
  # Required. The queue to create.
120
126
  #
121
- # [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as an existing queue.
127
+ # [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as
128
+ # an existing queue.
122
129
  class CreateQueueRequest
123
130
  include ::Google::Protobuf::MessageExts
124
131
  extend ::Google::Protobuf::MessageExts::ClassMethods
125
132
  end
126
133
 
127
- # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#update_queue UpdateQueue}.
134
+ # Request message for
135
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#update_queue UpdateQueue}.
128
136
  # @!attribute [rw] queue
129
137
  # @return [::Google::Cloud::Tasks::V2beta2::Queue]
130
138
  # Required. The queue to create or update.
131
139
  #
132
- # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} must be specified.
140
+ # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} must be
141
+ # specified.
133
142
  #
134
143
  # Output only fields cannot be modified using UpdateQueue.
135
144
  # Any value specified for an output only field will be ignored.
136
- # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be changed.
145
+ # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be
146
+ # changed.
137
147
  # @!attribute [rw] update_mask
138
148
  # @return [::Google::Protobuf::FieldMask]
139
149
  # A mask used to specify which fields of the queue are being updated.
@@ -144,7 +154,8 @@ module Google
144
154
  extend ::Google::Protobuf::MessageExts::ClassMethods
145
155
  end
146
156
 
147
- # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}.
157
+ # Request message for
158
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}.
148
159
  # @!attribute [rw] name
149
160
  # @return [::String]
150
161
  # Required. The queue name. For example:
@@ -154,7 +165,8 @@ module Google
154
165
  extend ::Google::Protobuf::MessageExts::ClassMethods
155
166
  end
156
167
 
157
- # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#purge_queue PurgeQueue}.
168
+ # Request message for
169
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#purge_queue PurgeQueue}.
158
170
  # @!attribute [rw] name
159
171
  # @return [::String]
160
172
  # Required. The queue name. For example:
@@ -164,7 +176,8 @@ module Google
164
176
  extend ::Google::Protobuf::MessageExts::ClassMethods
165
177
  end
166
178
 
167
- # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#pause_queue PauseQueue}.
179
+ # Request message for
180
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#pause_queue PauseQueue}.
168
181
  # @!attribute [rw] name
169
182
  # @return [::String]
170
183
  # Required. The queue name. For example:
@@ -174,7 +187,8 @@ module Google
174
187
  extend ::Google::Protobuf::MessageExts::ClassMethods
175
188
  end
176
189
 
177
- # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#resume_queue ResumeQueue}.
190
+ # Request message for
191
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#resume_queue ResumeQueue}.
178
192
  # @!attribute [rw] name
179
193
  # @return [::String]
180
194
  # Required. The queue name. For example:
@@ -184,32 +198,34 @@ module Google
184
198
  extend ::Google::Protobuf::MessageExts::ClassMethods
185
199
  end
186
200
 
187
- # Request message for listing tasks using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks}.
201
+ # Request message for listing tasks using
202
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks}.
188
203
  # @!attribute [rw] parent
189
204
  # @return [::String]
190
205
  # Required. The queue name. For example:
191
206
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
192
207
  # @!attribute [rw] response_view
193
208
  # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
194
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
195
- # returned.
196
- #
197
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
198
- # information is retrieved by default because some data, such as
199
- # payloads, might be desirable to return only when needed because
200
- # of its large size or because of the sensitivity of data that it
201
- # contains.
202
- #
203
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
204
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
205
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
209
+ # The response_view specifies which subset of the
210
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
211
+ #
212
+ # By default response_view is
213
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
214
+ # retrieved by default because some data, such as payloads, might be
215
+ # desirable to return only when needed because of its large size or because
216
+ # of the sensitivity of data that it contains.
217
+ #
218
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
219
+ # requires `cloudtasks.tasks.fullView` [Google
220
+ # IAM](https://cloud.google.com/iam/) permission on the
221
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
206
222
  # @!attribute [rw] page_size
207
223
  # @return [::Integer]
208
224
  # Maximum page size.
209
225
  #
210
226
  # Fewer tasks than requested might be returned, even if more tasks exist; use
211
- # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token} in the response to
212
- # determine if more tasks exist.
227
+ # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
228
+ # in the response to determine if more tasks exist.
213
229
  #
214
230
  # The maximum page size is 1000. If unspecified, the page size will be the
215
231
  # maximum.
@@ -219,9 +235,9 @@ module Google
219
235
  #
220
236
  # To request the first page results, page_token must be empty. To
221
237
  # request the next page of results, page_token must be the value of
222
- # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token} returned
223
- # from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks}
224
- # method.
238
+ # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
239
+ # returned from the previous call to
240
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks} method.
225
241
  #
226
242
  # The page token is valid for only 2 hours.
227
243
  class ListTasksRequest
@@ -229,7 +245,8 @@ module Google
229
245
  extend ::Google::Protobuf::MessageExts::ClassMethods
230
246
  end
231
247
 
232
- # Response message for listing tasks using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks}.
248
+ # Response message for listing tasks using
249
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks}.
233
250
  # @!attribute [rw] tasks
234
251
  # @return [::Array<::Google::Cloud::Tasks::V2beta2::Task>]
235
252
  # The list of tasks.
@@ -238,7 +255,8 @@ module Google
238
255
  # A token to retrieve next page of results.
239
256
  #
240
257
  # To return the next page of results, call
241
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks} with this value as the
258
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks} with this
259
+ # value as the
242
260
  # {::Google::Cloud::Tasks::V2beta2::ListTasksRequest#page_token page_token}.
243
261
  #
244
262
  # If the next_page_token is empty, there are no more results.
@@ -247,31 +265,34 @@ module Google
247
265
  extend ::Google::Protobuf::MessageExts::ClassMethods
248
266
  end
249
267
 
250
- # Request message for getting a task using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#get_task GetTask}.
268
+ # Request message for getting a task using
269
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#get_task GetTask}.
251
270
  # @!attribute [rw] name
252
271
  # @return [::String]
253
272
  # Required. The task name. For example:
254
273
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
255
274
  # @!attribute [rw] response_view
256
275
  # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
257
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
258
- # returned.
259
- #
260
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
261
- # information is retrieved by default because some data, such as
262
- # payloads, might be desirable to return only when needed because
263
- # of its large size or because of the sensitivity of data that it
264
- # contains.
265
- #
266
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
267
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
268
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
276
+ # The response_view specifies which subset of the
277
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
278
+ #
279
+ # By default response_view is
280
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
281
+ # retrieved by default because some data, such as payloads, might be
282
+ # desirable to return only when needed because of its large size or because
283
+ # of the sensitivity of data that it contains.
284
+ #
285
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
286
+ # requires `cloudtasks.tasks.fullView` [Google
287
+ # IAM](https://cloud.google.com/iam/) permission on the
288
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
269
289
  class GetTaskRequest
270
290
  include ::Google::Protobuf::MessageExts
271
291
  extend ::Google::Protobuf::MessageExts::ClassMethods
272
292
  end
273
293
 
274
- # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask}.
294
+ # Request message for
295
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask}.
275
296
  # @!attribute [rw] parent
276
297
  # @return [::String]
277
298
  # Required. The queue name. For example:
@@ -284,13 +305,13 @@ module Google
284
305
  #
285
306
  # Task names have the following format:
286
307
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
287
- # The user can optionally specify a task {::Google::Cloud::Tasks::V2beta2::Task#name name}. If a
288
- # name is not specified then the system will generate a random
289
- # unique task id, which will be set in the task returned in the
290
- # {::Google::Cloud::Tasks::V2beta2::Task#name response}.
308
+ # The user can optionally specify a task
309
+ # {::Google::Cloud::Tasks::V2beta2::Task#name name}. If a name is not specified
310
+ # then the system will generate a random unique task id, which will be set in
311
+ # the task returned in the {::Google::Cloud::Tasks::V2beta2::Task#name response}.
291
312
  #
292
- # If {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not set or is in the
293
- # past then Cloud Tasks will set it to the current time.
313
+ # If {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not
314
+ # set or is in the past then Cloud Tasks will set it to the current time.
294
315
  #
295
316
  # Task De-duplication:
296
317
  #
@@ -305,28 +326,29 @@ module Google
305
326
  # for ~9days after the original task was deleted or completed.
306
327
  #
307
328
  # Because there is an extra lookup cost to identify duplicate task
308
- # names, these {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask} calls have significantly
309
- # increased latency. Using hashed strings for the task id or for
310
- # the prefix of the task id is recommended. Choosing task ids that
311
- # are sequential or have sequential prefixes, for example using a
329
+ # names, these {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask}
330
+ # calls have significantly increased latency. Using hashed strings for the
331
+ # task id or for the prefix of the task id is recommended. Choosing task ids
332
+ # that are sequential or have sequential prefixes, for example using a
312
333
  # timestamp, causes an increase in latency and error rates in all
313
334
  # task commands. The infrastructure relies on an approximately
314
335
  # uniform distribution of task ids to store and serve tasks
315
336
  # efficiently.
316
337
  # @!attribute [rw] response_view
317
338
  # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
318
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
319
- # returned.
320
- #
321
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
322
- # information is retrieved by default because some data, such as
323
- # payloads, might be desirable to return only when needed because
324
- # of its large size or because of the sensitivity of data that it
325
- # contains.
326
- #
327
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
328
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
329
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
339
+ # The response_view specifies which subset of the
340
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
341
+ #
342
+ # By default response_view is
343
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
344
+ # retrieved by default because some data, such as payloads, might be
345
+ # desirable to return only when needed because of its large size or because
346
+ # of the sensitivity of data that it contains.
347
+ #
348
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
349
+ # requires `cloudtasks.tasks.fullView` [Google
350
+ # IAM](https://cloud.google.com/iam/) permission on the
351
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
330
352
  class CreateTaskRequest
331
353
  include ::Google::Protobuf::MessageExts
332
354
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -343,7 +365,8 @@ module Google
343
365
  extend ::Google::Protobuf::MessageExts::ClassMethods
344
366
  end
345
367
 
346
- # Request message for leasing tasks using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks}.
368
+ # Request message for leasing tasks using
369
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks}.
347
370
  # @!attribute [rw] parent
348
371
  # @return [::String]
349
372
  # Required. The queue name. For example:
@@ -357,56 +380,62 @@ module Google
357
380
  #
358
381
  # The largest that `max_tasks` can be is 1000.
359
382
  #
360
- # The maximum total size of a {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse lease tasks response} is
361
- # 32 MB. If the sum of all task sizes requested reaches this limit,
362
- # fewer tasks than requested are returned.
383
+ # The maximum total size of a [lease tasks
384
+ # response][google.cloud.tasks.v2beta2.LeaseTasksResponse] is 32 MB. If the
385
+ # sum of all task sizes requested reaches this limit, fewer tasks than
386
+ # requested are returned.
363
387
  # @!attribute [rw] lease_duration
364
388
  # @return [::Google::Protobuf::Duration]
365
389
  # Required. The duration of the lease.
366
390
  #
367
- # Each task returned in the {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will
368
- # have its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} set to the current
369
- # time plus the `lease_duration`. The task is leased until its
370
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}; thus, the task will not be
371
- # returned to another {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call
372
- # before its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
391
+ # Each task returned in the
392
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will have its
393
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} set to the
394
+ # current time plus the `lease_duration`. The task is leased until its
395
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}; thus, the
396
+ # task will not be returned to another
397
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call before
398
+ # its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
373
399
  #
374
400
  #
375
401
  # After the worker has successfully finished the work associated
376
402
  # with the task, the worker must call via
377
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask} before the
378
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}. Otherwise the task will be
379
- # returned to a later {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call so
380
- # that another worker can retry it.
403
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask}
404
+ # before the {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
405
+ # Otherwise the task will be returned to a later
406
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call so that
407
+ # another worker can retry it.
381
408
  #
382
409
  # The maximum lease duration is 1 week.
383
410
  # `lease_duration` will be truncated to the nearest second.
384
411
  # @!attribute [rw] response_view
385
412
  # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
386
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
387
- # returned.
388
- #
389
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
390
- # information is retrieved by default because some data, such as
391
- # payloads, might be desirable to return only when needed because
392
- # of its large size or because of the sensitivity of data that it
393
- # contains.
394
- #
395
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
396
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
397
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
413
+ # The response_view specifies which subset of the
414
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
415
+ #
416
+ # By default response_view is
417
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
418
+ # retrieved by default because some data, such as payloads, might be
419
+ # desirable to return only when needed because of its large size or because
420
+ # of the sensitivity of data that it contains.
421
+ #
422
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
423
+ # requires `cloudtasks.tasks.fullView` [Google
424
+ # IAM](https://cloud.google.com/iam/) permission on the
425
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
398
426
  # @!attribute [rw] filter
399
427
  # @return [::String]
400
428
  # `filter` can be used to specify a subset of tasks to lease.
401
429
  #
402
430
  # When `filter` is set to `tag=<my-tag>` then the
403
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only tasks whose
404
- # {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to `<my-tag>`. `<my-tag>` must be
405
- # less than 500 characters.
431
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only
432
+ # tasks whose {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to
433
+ # `<my-tag>`. `<my-tag>` must be less than 500 characters.
406
434
  #
407
435
  # When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
408
436
  # the same tag as the task with the oldest
409
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be returned.
437
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
438
+ # returned.
410
439
  #
411
440
  # Grammar Syntax:
412
441
  #
@@ -424,14 +453,16 @@ module Google
424
453
  # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
425
454
  # only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
426
455
  # aren't UTF-8 encoded can't be used in the
427
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the task's
428
- # {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed as empty in Cloud Tasks.
456
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the
457
+ # task's {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed
458
+ # as empty in Cloud Tasks.
429
459
  class LeaseTasksRequest
430
460
  include ::Google::Protobuf::MessageExts
431
461
  extend ::Google::Protobuf::MessageExts::ClassMethods
432
462
  end
433
463
 
434
- # Response message for leasing tasks using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks}.
464
+ # Response message for leasing tasks using
465
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks}.
435
466
  # @!attribute [rw] tasks
436
467
  # @return [::Array<::Google::Cloud::Tasks::V2beta2::Task>]
437
468
  # The leased tasks.
@@ -451,8 +482,8 @@ module Google
451
482
  # Required. The task's current schedule time, available in the
452
483
  # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
453
484
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
454
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response. This restriction is
455
- # to ensure that your worker currently holds the lease.
485
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response.
486
+ # This restriction is to ensure that your worker currently holds the lease.
456
487
  class AcknowledgeTaskRequest
457
488
  include ::Google::Protobuf::MessageExts
458
489
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -469,8 +500,8 @@ module Google
469
500
  # Required. The task's current schedule time, available in the
470
501
  # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
471
502
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
472
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response. This restriction is
473
- # to ensure that your worker currently holds the lease.
503
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response.
504
+ # This restriction is to ensure that your worker currently holds the lease.
474
505
  # @!attribute [rw] lease_duration
475
506
  # @return [::Google::Protobuf::Duration]
476
507
  # Required. The desired new lease duration, starting from now.
@@ -480,18 +511,19 @@ module Google
480
511
  # `lease_duration` will be truncated to the nearest second.
481
512
  # @!attribute [rw] response_view
482
513
  # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
483
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
484
- # returned.
485
- #
486
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
487
- # information is retrieved by default because some data, such as
488
- # payloads, might be desirable to return only when needed because
489
- # of its large size or because of the sensitivity of data that it
490
- # contains.
491
- #
492
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
493
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
494
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
514
+ # The response_view specifies which subset of the
515
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
516
+ #
517
+ # By default response_view is
518
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
519
+ # retrieved by default because some data, such as payloads, might be
520
+ # desirable to return only when needed because of its large size or because
521
+ # of the sensitivity of data that it contains.
522
+ #
523
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
524
+ # requires `cloudtasks.tasks.fullView` [Google
525
+ # IAM](https://cloud.google.com/iam/) permission on the
526
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
495
527
  class RenewLeaseRequest
496
528
  include ::Google::Protobuf::MessageExts
497
529
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -508,22 +540,23 @@ module Google
508
540
  # Required. The task's current schedule time, available in the
509
541
  # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
510
542
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
511
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response. This restriction is
512
- # to ensure that your worker currently holds the lease.
543
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response.
544
+ # This restriction is to ensure that your worker currently holds the lease.
513
545
  # @!attribute [rw] response_view
514
546
  # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
515
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
516
- # returned.
517
- #
518
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
519
- # information is retrieved by default because some data, such as
520
- # payloads, might be desirable to return only when needed because
521
- # of its large size or because of the sensitivity of data that it
522
- # contains.
523
- #
524
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
525
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
526
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
547
+ # The response_view specifies which subset of the
548
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
549
+ #
550
+ # By default response_view is
551
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
552
+ # retrieved by default because some data, such as payloads, might be
553
+ # desirable to return only when needed because of its large size or because
554
+ # of the sensitivity of data that it contains.
555
+ #
556
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
557
+ # requires `cloudtasks.tasks.fullView` [Google
558
+ # IAM](https://cloud.google.com/iam/) permission on the
559
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
527
560
  class CancelLeaseRequest
528
561
  include ::Google::Protobuf::MessageExts
529
562
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -537,18 +570,19 @@ module Google
537
570
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
538
571
  # @!attribute [rw] response_view
539
572
  # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
540
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
541
- # returned.
542
- #
543
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
544
- # information is retrieved by default because some data, such as
545
- # payloads, might be desirable to return only when needed because
546
- # of its large size or because of the sensitivity of data that it
547
- # contains.
548
- #
549
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
550
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
551
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
573
+ # The response_view specifies which subset of the
574
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
575
+ #
576
+ # By default response_view is
577
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
578
+ # retrieved by default because some data, such as payloads, might be
579
+ # desirable to return only when needed because of its large size or because
580
+ # of the sensitivity of data that it contains.
581
+ #
582
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
583
+ # requires `cloudtasks.tasks.fullView` [Google
584
+ # IAM](https://cloud.google.com/iam/) permission on the
585
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
552
586
  class RunTaskRequest
553
587
  include ::Google::Protobuf::MessageExts
554
588
  extend ::Google::Protobuf::MessageExts::ClassMethods