google-cloud-tasks-v2beta2 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +203 -0
  5. data/README.md +71 -0
  6. data/lib/google-cloud-tasks-v2beta2.rb +21 -0
  7. data/lib/google/cloud/common_resources_pb.rb +15 -0
  8. data/lib/google/cloud/tasks/v2beta2.rb +35 -0
  9. data/lib/google/cloud/tasks/v2beta2/cloud_tasks.rb +50 -0
  10. data/lib/google/cloud/tasks/v2beta2/cloud_tasks/client.rb +2324 -0
  11. data/lib/google/cloud/tasks/v2beta2/cloud_tasks/credentials.rb +51 -0
  12. data/lib/google/cloud/tasks/v2beta2/cloud_tasks/paths.rb +90 -0
  13. data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +134 -0
  14. data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +257 -0
  15. data/lib/google/cloud/tasks/v2beta2/queue_pb.rb +59 -0
  16. data/lib/google/cloud/tasks/v2beta2/target_pb.rb +55 -0
  17. data/lib/google/cloud/tasks/v2beta2/task_pb.rb +55 -0
  18. data/lib/google/cloud/tasks/v2beta2/version.rb +28 -0
  19. data/proto_docs/README.md +4 -0
  20. data/proto_docs/google/api/field_behavior.rb +59 -0
  21. data/proto_docs/google/api/resource.rb +247 -0
  22. data/proto_docs/google/cloud/tasks/v2beta2/cloudtasks.rb +547 -0
  23. data/proto_docs/google/cloud/tasks/v2beta2/queue.rb +349 -0
  24. data/proto_docs/google/cloud/tasks/v2beta2/target.rb +405 -0
  25. data/proto_docs/google/cloud/tasks/v2beta2/task.rb +179 -0
  26. data/proto_docs/google/iam/v1/iam_policy.rb +80 -0
  27. data/proto_docs/google/iam/v1/options.rb +40 -0
  28. data/proto_docs/google/iam/v1/policy.rb +248 -0
  29. data/proto_docs/google/protobuf/any.rb +138 -0
  30. data/proto_docs/google/protobuf/duration.rb +98 -0
  31. data/proto_docs/google/protobuf/empty.rb +36 -0
  32. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  33. data/proto_docs/google/protobuf/timestamp.rb +120 -0
  34. data/proto_docs/google/rpc/status.rb +46 -0
  35. data/proto_docs/google/type/expr.rb +52 -0
  36. metadata +211 -0
@@ -0,0 +1,547 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Tasks
23
+ module V2beta2
24
+ # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The location name.
28
+ # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
29
+ # @!attribute [rw] filter
30
+ # @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
36
+ # Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
37
+ #
38
+ # Sample filter "app_engine_http_target: *".
39
+ #
40
+ # Note that using filters might cause fewer queues than the
41
+ # requested_page size to be returned.
42
+ # @!attribute [rw] page_size
43
+ # @return [::Integer]
44
+ # Requested page size.
45
+ #
46
+ # The maximum page size is 9800. If unspecified, the page size will
47
+ # be the maximum. Fewer queues than requested might be returned,
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.
51
+ # @!attribute [rw] page_token
52
+ # @return [::String]
53
+ # A token identifying the page of results to return.
54
+ #
55
+ # To request the first page results, page_token must be empty. To
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.
61
+ class ListQueuesRequest
62
+ include ::Google::Protobuf::MessageExts
63
+ extend ::Google::Protobuf::MessageExts::ClassMethods
64
+ end
65
+
66
+ # Response message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}.
67
+ # @!attribute [rw] queues
68
+ # @return [::Array<::Google::Cloud::Tasks::V2beta2::Queue>]
69
+ # The list of queues.
70
+ # @!attribute [rw] next_page_token
71
+ # @return [::String]
72
+ # A token to retrieve next page of results.
73
+ #
74
+ # To return the next page of results, call
75
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues} with this value as the
76
+ # {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#page_token page_token}.
77
+ #
78
+ # If the next_page_token is empty, there are no more results.
79
+ #
80
+ # The page token is valid for only 2 hours.
81
+ class ListQueuesResponse
82
+ include ::Google::Protobuf::MessageExts
83
+ extend ::Google::Protobuf::MessageExts::ClassMethods
84
+ end
85
+
86
+ # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#get_queue GetQueue}.
87
+ # @!attribute [rw] name
88
+ # @return [::String]
89
+ # Required. The resource name of the queue. For example:
90
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
91
+ class GetQueueRequest
92
+ include ::Google::Protobuf::MessageExts
93
+ extend ::Google::Protobuf::MessageExts::ClassMethods
94
+ end
95
+
96
+ # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_queue CreateQueue}.
97
+ # @!attribute [rw] parent
98
+ # @return [::String]
99
+ # Required. The location name in which the queue will be created.
100
+ # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
101
+ #
102
+ # The list of allowed locations can be obtained by calling Cloud
103
+ # Tasks' implementation of
104
+ # [ListLocations][google.cloud.location.Locations.ListLocations].
105
+ # @!attribute [rw] queue
106
+ # @return [::Google::Cloud::Tasks::V2beta2::Queue]
107
+ # Required. The queue to create.
108
+ #
109
+ # [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as an existing queue.
110
+ class CreateQueueRequest
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
+ end
114
+
115
+ # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#update_queue UpdateQueue}.
116
+ # @!attribute [rw] queue
117
+ # @return [::Google::Cloud::Tasks::V2beta2::Queue]
118
+ # Required. The queue to create or update.
119
+ #
120
+ # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} must be specified.
121
+ #
122
+ # Output only fields cannot be modified using UpdateQueue.
123
+ # Any value specified for an output only field will be ignored.
124
+ # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be changed.
125
+ # @!attribute [rw] update_mask
126
+ # @return [::Google::Protobuf::FieldMask]
127
+ # A mask used to specify which fields of the queue are being updated.
128
+ #
129
+ # If empty, then all fields will be updated.
130
+ class UpdateQueueRequest
131
+ include ::Google::Protobuf::MessageExts
132
+ extend ::Google::Protobuf::MessageExts::ClassMethods
133
+ end
134
+
135
+ # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}.
136
+ # @!attribute [rw] name
137
+ # @return [::String]
138
+ # Required. The queue name. For example:
139
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
140
+ class DeleteQueueRequest
141
+ include ::Google::Protobuf::MessageExts
142
+ extend ::Google::Protobuf::MessageExts::ClassMethods
143
+ end
144
+
145
+ # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#purge_queue PurgeQueue}.
146
+ # @!attribute [rw] name
147
+ # @return [::String]
148
+ # Required. The queue name. For example:
149
+ # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
150
+ class PurgeQueueRequest
151
+ include ::Google::Protobuf::MessageExts
152
+ extend ::Google::Protobuf::MessageExts::ClassMethods
153
+ end
154
+
155
+ # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#pause_queue PauseQueue}.
156
+ # @!attribute [rw] name
157
+ # @return [::String]
158
+ # Required. The queue name. For example:
159
+ # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
160
+ class PauseQueueRequest
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+
165
+ # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#resume_queue ResumeQueue}.
166
+ # @!attribute [rw] name
167
+ # @return [::String]
168
+ # Required. The queue name. For example:
169
+ # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
170
+ class ResumeQueueRequest
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Request message for listing tasks using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks}.
176
+ # @!attribute [rw] parent
177
+ # @return [::String]
178
+ # Required. The queue name. For example:
179
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
180
+ # @!attribute [rw] response_view
181
+ # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
182
+ # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
183
+ # returned.
184
+ #
185
+ # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
186
+ # information is retrieved by default because some data, such as
187
+ # payloads, might be desirable to return only when needed because
188
+ # of its large size or because of the sensitivity of data that it
189
+ # contains.
190
+ #
191
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
192
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
193
+ # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
194
+ # @!attribute [rw] page_size
195
+ # @return [::Integer]
196
+ # Maximum page size.
197
+ #
198
+ # Fewer tasks than requested might be returned, even if more tasks exist; use
199
+ # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token} in the response to
200
+ # determine if more tasks exist.
201
+ #
202
+ # The maximum page size is 1000. If unspecified, the page size will be the
203
+ # maximum.
204
+ # @!attribute [rw] page_token
205
+ # @return [::String]
206
+ # A token identifying the page of results to return.
207
+ #
208
+ # To request the first page results, page_token must be empty. To
209
+ # request the next page of results, page_token must be the value of
210
+ # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token} returned
211
+ # from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks}
212
+ # method.
213
+ #
214
+ # The page token is valid for only 2 hours.
215
+ class ListTasksRequest
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Response message for listing tasks using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks}.
221
+ # @!attribute [rw] tasks
222
+ # @return [::Array<::Google::Cloud::Tasks::V2beta2::Task>]
223
+ # The list of tasks.
224
+ # @!attribute [rw] next_page_token
225
+ # @return [::String]
226
+ # A token to retrieve next page of results.
227
+ #
228
+ # To return the next page of results, call
229
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks} with this value as the
230
+ # {::Google::Cloud::Tasks::V2beta2::ListTasksRequest#page_token page_token}.
231
+ #
232
+ # If the next_page_token is empty, there are no more results.
233
+ class ListTasksResponse
234
+ include ::Google::Protobuf::MessageExts
235
+ extend ::Google::Protobuf::MessageExts::ClassMethods
236
+ end
237
+
238
+ # Request message for getting a task using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#get_task GetTask}.
239
+ # @!attribute [rw] name
240
+ # @return [::String]
241
+ # Required. The task name. For example:
242
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
243
+ # @!attribute [rw] response_view
244
+ # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
245
+ # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
246
+ # returned.
247
+ #
248
+ # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
249
+ # information is retrieved by default because some data, such as
250
+ # payloads, might be desirable to return only when needed because
251
+ # of its large size or because of the sensitivity of data that it
252
+ # contains.
253
+ #
254
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
255
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
256
+ # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
257
+ class GetTaskRequest
258
+ include ::Google::Protobuf::MessageExts
259
+ extend ::Google::Protobuf::MessageExts::ClassMethods
260
+ end
261
+
262
+ # Request message for {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask}.
263
+ # @!attribute [rw] parent
264
+ # @return [::String]
265
+ # Required. The queue name. For example:
266
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
267
+ #
268
+ # The queue must already exist.
269
+ # @!attribute [rw] task
270
+ # @return [::Google::Cloud::Tasks::V2beta2::Task]
271
+ # Required. The task to add.
272
+ #
273
+ # Task names have the following format:
274
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
275
+ # The user can optionally specify a task {::Google::Cloud::Tasks::V2beta2::Task#name name}. If a
276
+ # name is not specified then the system will generate a random
277
+ # unique task id, which will be set in the task returned in the
278
+ # {::Google::Cloud::Tasks::V2beta2::Task#name response}.
279
+ #
280
+ # If {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not set or is in the
281
+ # past then Cloud Tasks will set it to the current time.
282
+ #
283
+ # Task De-duplication:
284
+ #
285
+ # Explicitly specifying a task ID enables task de-duplication. If
286
+ # a task's ID is identical to that of an existing task or a task
287
+ # that was deleted or completed recently then the call will fail
288
+ # with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
289
+ # If the task's queue was created using Cloud Tasks, then another task with
290
+ # the same name can't be created for ~1hour after the original task was
291
+ # deleted or completed. If the task's queue was created using queue.yaml or
292
+ # queue.xml, then another task with the same name can't be created
293
+ # for ~9days after the original task was deleted or completed.
294
+ #
295
+ # Because there is an extra lookup cost to identify duplicate task
296
+ # names, these {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask} calls have significantly
297
+ # increased latency. Using hashed strings for the task id or for
298
+ # the prefix of the task id is recommended. Choosing task ids that
299
+ # are sequential or have sequential prefixes, for example using a
300
+ # timestamp, causes an increase in latency and error rates in all
301
+ # task commands. The infrastructure relies on an approximately
302
+ # uniform distribution of task ids to store and serve tasks
303
+ # efficiently.
304
+ # @!attribute [rw] response_view
305
+ # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
306
+ # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
307
+ # returned.
308
+ #
309
+ # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
310
+ # information is retrieved by default because some data, such as
311
+ # payloads, might be desirable to return only when needed because
312
+ # of its large size or because of the sensitivity of data that it
313
+ # contains.
314
+ #
315
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
316
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
317
+ # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
318
+ class CreateTaskRequest
319
+ include ::Google::Protobuf::MessageExts
320
+ extend ::Google::Protobuf::MessageExts::ClassMethods
321
+ end
322
+
323
+ # Request message for deleting a task using
324
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_task DeleteTask}.
325
+ # @!attribute [rw] name
326
+ # @return [::String]
327
+ # Required. The task name. For example:
328
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
329
+ class DeleteTaskRequest
330
+ include ::Google::Protobuf::MessageExts
331
+ extend ::Google::Protobuf::MessageExts::ClassMethods
332
+ end
333
+
334
+ # Request message for leasing tasks using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks}.
335
+ # @!attribute [rw] parent
336
+ # @return [::String]
337
+ # Required. The queue name. For example:
338
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
339
+ # @!attribute [rw] max_tasks
340
+ # @return [::Integer]
341
+ # The maximum number of tasks to lease.
342
+ #
343
+ # The system will make a best effort to return as close to as
344
+ # `max_tasks` as possible.
345
+ #
346
+ # The largest that `max_tasks` can be is 1000.
347
+ #
348
+ # The maximum total size of a {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse lease tasks response} is
349
+ # 32 MB. If the sum of all task sizes requested reaches this limit,
350
+ # fewer tasks than requested are returned.
351
+ # @!attribute [rw] lease_duration
352
+ # @return [::Google::Protobuf::Duration]
353
+ # Required. The duration of the lease.
354
+ #
355
+ # Each task returned in the {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will
356
+ # have its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} set to the current
357
+ # time plus the `lease_duration`. The task is leased until its
358
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}; thus, the task will not be
359
+ # returned to another {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call
360
+ # before its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
361
+ #
362
+ #
363
+ # After the worker has successfully finished the work associated
364
+ # with the task, the worker must call via
365
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask} before the
366
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}. Otherwise the task will be
367
+ # returned to a later {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call so
368
+ # that another worker can retry it.
369
+ #
370
+ # The maximum lease duration is 1 week.
371
+ # `lease_duration` will be truncated to the nearest second.
372
+ # @!attribute [rw] response_view
373
+ # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
374
+ # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
375
+ # returned.
376
+ #
377
+ # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
378
+ # information is retrieved by default because some data, such as
379
+ # payloads, might be desirable to return only when needed because
380
+ # of its large size or because of the sensitivity of data that it
381
+ # contains.
382
+ #
383
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
384
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
385
+ # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
386
+ # @!attribute [rw] filter
387
+ # @return [::String]
388
+ # `filter` can be used to specify a subset of tasks to lease.
389
+ #
390
+ # When `filter` is set to `tag=<my-tag>` then the
391
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only tasks whose
392
+ # {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to `<my-tag>`. `<my-tag>` must be
393
+ # less than 500 characters.
394
+ #
395
+ # When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
396
+ # the same tag as the task with the oldest
397
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be returned.
398
+ #
399
+ # Grammar Syntax:
400
+ #
401
+ # * `filter = "tag=" tag | "tag_function=" function`
402
+ #
403
+ # * `tag = string`
404
+ #
405
+ # * `function = "oldest_tag()"`
406
+ #
407
+ # The `oldest_tag()` function returns tasks which have the same tag as the
408
+ # oldest task (ordered by schedule time).
409
+ #
410
+ # SDK compatibility: Although the SDK allows tags to be either
411
+ # string or
412
+ # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
413
+ # only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
414
+ # aren't UTF-8 encoded can't be used in the
415
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the task's
416
+ # {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed as empty in Cloud Tasks.
417
+ class LeaseTasksRequest
418
+ include ::Google::Protobuf::MessageExts
419
+ extend ::Google::Protobuf::MessageExts::ClassMethods
420
+ end
421
+
422
+ # Response message for leasing tasks using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks}.
423
+ # @!attribute [rw] tasks
424
+ # @return [::Array<::Google::Cloud::Tasks::V2beta2::Task>]
425
+ # The leased tasks.
426
+ class LeaseTasksResponse
427
+ include ::Google::Protobuf::MessageExts
428
+ extend ::Google::Protobuf::MessageExts::ClassMethods
429
+ end
430
+
431
+ # Request message for acknowledging a task using
432
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask}.
433
+ # @!attribute [rw] name
434
+ # @return [::String]
435
+ # Required. The task name. For example:
436
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
437
+ # @!attribute [rw] schedule_time
438
+ # @return [::Google::Protobuf::Timestamp]
439
+ # Required. The task's current schedule time, available in the
440
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
441
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
442
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response. This restriction is
443
+ # to ensure that your worker currently holds the lease.
444
+ class AcknowledgeTaskRequest
445
+ include ::Google::Protobuf::MessageExts
446
+ extend ::Google::Protobuf::MessageExts::ClassMethods
447
+ end
448
+
449
+ # Request message for renewing a lease using
450
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease}.
451
+ # @!attribute [rw] name
452
+ # @return [::String]
453
+ # Required. The task name. For example:
454
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
455
+ # @!attribute [rw] schedule_time
456
+ # @return [::Google::Protobuf::Timestamp]
457
+ # Required. The task's current schedule time, available in the
458
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
459
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
460
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response. This restriction is
461
+ # to ensure that your worker currently holds the lease.
462
+ # @!attribute [rw] lease_duration
463
+ # @return [::Google::Protobuf::Duration]
464
+ # Required. The desired new lease duration, starting from now.
465
+ #
466
+ #
467
+ # The maximum lease duration is 1 week.
468
+ # `lease_duration` will be truncated to the nearest second.
469
+ # @!attribute [rw] response_view
470
+ # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
471
+ # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
472
+ # returned.
473
+ #
474
+ # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
475
+ # information is retrieved by default because some data, such as
476
+ # payloads, might be desirable to return only when needed because
477
+ # of its large size or because of the sensitivity of data that it
478
+ # contains.
479
+ #
480
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
481
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
482
+ # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
483
+ class RenewLeaseRequest
484
+ include ::Google::Protobuf::MessageExts
485
+ extend ::Google::Protobuf::MessageExts::ClassMethods
486
+ end
487
+
488
+ # Request message for canceling a lease using
489
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#cancel_lease CancelLease}.
490
+ # @!attribute [rw] name
491
+ # @return [::String]
492
+ # Required. The task name. For example:
493
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
494
+ # @!attribute [rw] schedule_time
495
+ # @return [::Google::Protobuf::Timestamp]
496
+ # Required. The task's current schedule time, available in the
497
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
498
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
499
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response. This restriction is
500
+ # to ensure that your worker currently holds the lease.
501
+ # @!attribute [rw] response_view
502
+ # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
503
+ # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
504
+ # returned.
505
+ #
506
+ # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
507
+ # information is retrieved by default because some data, such as
508
+ # payloads, might be desirable to return only when needed because
509
+ # of its large size or because of the sensitivity of data that it
510
+ # contains.
511
+ #
512
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
513
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
514
+ # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
515
+ class CancelLeaseRequest
516
+ include ::Google::Protobuf::MessageExts
517
+ extend ::Google::Protobuf::MessageExts::ClassMethods
518
+ end
519
+
520
+ # Request message for forcing a task to run now using
521
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask}.
522
+ # @!attribute [rw] name
523
+ # @return [::String]
524
+ # Required. The task name. For example:
525
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
526
+ # @!attribute [rw] response_view
527
+ # @return [::Google::Cloud::Tasks::V2beta2::Task::View]
528
+ # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
529
+ # returned.
530
+ #
531
+ # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
532
+ # information is retrieved by default because some data, such as
533
+ # payloads, might be desirable to return only when needed because
534
+ # of its large size or because of the sensitivity of data that it
535
+ # contains.
536
+ #
537
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
538
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
539
+ # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
540
+ class RunTaskRequest
541
+ include ::Google::Protobuf::MessageExts
542
+ extend ::Google::Protobuf::MessageExts::ClassMethods
543
+ end
544
+ end
545
+ end
546
+ end
547
+ end