google-cloud-tasks-v2beta2 0.8.0 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -224,11 +224,10 @@ module Google
224
224
  # Required. The location name.
225
225
  # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
226
226
  # @param filter [::String]
227
- # `filter` can be used to specify a subset of queues. Any {::Google::Cloud::Tasks::V2beta2::Queue Queue}
228
- # field can be used as a filter and several operators as supported.
229
- # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
230
- # described in
231
- # [Stackdriver's Advanced Logs
227
+ # `filter` can be used to specify a subset of queues. Any
228
+ # {::Google::Cloud::Tasks::V2beta2::Queue Queue} field can be used as a filter and
229
+ # several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
230
+ # filter syntax is the same as described in [Stackdriver's Advanced Logs
232
231
  # Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
233
232
  #
234
233
  # Sample filter "app_engine_http_target: *".
@@ -241,20 +240,22 @@ module Google
241
240
  # The maximum page size is 9800. If unspecified, the page size will
242
241
  # be the maximum. Fewer queues than requested might be returned,
243
242
  # even if more queues exist; use the
244
- # {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token} in the
245
- # response to determine if more queues exist.
243
+ # {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
244
+ # in the response to determine if more queues exist.
246
245
  # @param page_token [::String]
247
246
  # A token identifying the page of results to return.
248
247
  #
249
248
  # To request the first page results, page_token must be empty. To
250
249
  # request the next page of results, page_token must be the value of
251
- # {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token} returned
252
- # from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#list_queues ListQueues}
253
- # method. It is an error to switch the value of the
254
- # {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while iterating through pages.
250
+ # {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
251
+ # returned from the previous call to
252
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#list_queues ListQueues} method. It
253
+ # is an error to switch the value of the
254
+ # {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while
255
+ # iterating through pages.
255
256
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
256
- # Optional. Read mask is used for a more granular control over what the API returns.
257
- # If the mask is not present all fields will be returned except
257
+ # Optional. Read mask is used for a more granular control over what the API
258
+ # returns. If the mask is not present all fields will be returned except
258
259
  # [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
259
260
  # specified in the mask.
260
261
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -322,8 +323,8 @@ module Google
322
323
  # Required. The resource name of the queue. For example:
323
324
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
324
325
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
325
- # Optional. Read mask is used for a more granular control over what the API returns.
326
- # If the mask is not present all fields will be returned except
326
+ # Optional. Read mask is used for a more granular control over what the API
327
+ # returns. If the mask is not present all fields will be returned except
327
328
  # [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
328
329
  # specified in the mask.
329
330
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -372,8 +373,8 @@ module Google
372
373
  # Creates a queue.
373
374
  #
374
375
  # Queues created with this method allow tasks to live for a maximum of 31
375
- # days. After a task is 31 days old, the task will be deleted regardless of whether
376
- # it was dispatched or not.
376
+ # days. After a task is 31 days old, the task will be deleted regardless of
377
+ # whether it was dispatched or not.
377
378
  #
378
379
  # WARNING: Using this method may have unintended side effects if you are
379
380
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
@@ -407,7 +408,8 @@ module Google
407
408
  # @param queue [::Google::Cloud::Tasks::V2beta2::Queue, ::Hash]
408
409
  # Required. The queue to create.
409
410
  #
410
- # [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as an existing queue.
411
+ # [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as
412
+ # an existing queue.
411
413
  # @yield [result, operation] Access the result along with the TransportOperation object
412
414
  # @yieldparam result [::Google::Cloud::Tasks::V2beta2::Queue]
413
415
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -457,8 +459,8 @@ module Google
457
459
  # the queue if it does exist.
458
460
  #
459
461
  # Queues created with this method allow tasks to live for a maximum of 31
460
- # days. After a task is 31 days old, the task will be deleted regardless of whether
461
- # it was dispatched or not.
462
+ # days. After a task is 31 days old, the task will be deleted regardless of
463
+ # whether it was dispatched or not.
462
464
  #
463
465
  # WARNING: Using this method may have unintended side effects if you are
464
466
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
@@ -485,11 +487,13 @@ module Google
485
487
  # @param queue [::Google::Cloud::Tasks::V2beta2::Queue, ::Hash]
486
488
  # Required. The queue to create or update.
487
489
  #
488
- # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} must be specified.
490
+ # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} must be
491
+ # specified.
489
492
  #
490
493
  # Output only fields cannot be modified using UpdateQueue.
491
494
  # Any value specified for an output only field will be ignored.
492
- # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be changed.
495
+ # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be
496
+ # changed.
493
497
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
494
498
  # A mask used to specify which fields of the queue are being updated.
495
499
  #
@@ -684,9 +688,10 @@ module Google
684
688
  #
685
689
  # If a queue is paused then the system will stop dispatching tasks
686
690
  # until the queue is resumed via
687
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#resume_queue ResumeQueue}. Tasks can still be added
688
- # when the queue is paused. A queue is paused if its
689
- # {::Google::Cloud::Tasks::V2beta2::Queue#state state} is {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
691
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#resume_queue ResumeQueue}. Tasks can
692
+ # still be added when the queue is paused. A queue is paused if its
693
+ # {::Google::Cloud::Tasks::V2beta2::Queue#state state} is
694
+ # {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
690
695
  #
691
696
  # @overload pause_queue(request, options = nil)
692
697
  # Pass arguments to `pause_queue` via a request object, either of type
@@ -753,9 +758,11 @@ module Google
753
758
  #
754
759
  # This method resumes a queue after it has been
755
760
  # {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED} or
756
- # {::Google::Cloud::Tasks::V2beta2::Queue::State::DISABLED DISABLED}. The state of a queue is stored
757
- # in the queue's {::Google::Cloud::Tasks::V2beta2::Queue#state state}; after calling this method it
758
- # will be set to {::Google::Cloud::Tasks::V2beta2::Queue::State::RUNNING RUNNING}.
761
+ # {::Google::Cloud::Tasks::V2beta2::Queue::State::DISABLED DISABLED}. The state of a
762
+ # queue is stored in the queue's
763
+ # {::Google::Cloud::Tasks::V2beta2::Queue#state state}; after calling this method
764
+ # it will be set to
765
+ # {::Google::Cloud::Tasks::V2beta2::Queue::State::RUNNING RUNNING}.
759
766
  #
760
767
  # WARNING: Resuming many high-QPS queues at the same time can
761
768
  # lead to target overloading. If you are resuming high-QPS
@@ -824,9 +831,9 @@ module Google
824
831
  end
825
832
 
826
833
  ##
827
- # Gets the access control policy for a {::Google::Cloud::Tasks::V2beta2::Queue Queue}.
828
- # Returns an empty policy if the resource exists and does not have a policy
829
- # set.
834
+ # Gets the access control policy for a
835
+ # {::Google::Cloud::Tasks::V2beta2::Queue Queue}. Returns an empty policy if the
836
+ # resource exists and does not have a policy set.
830
837
  #
831
838
  # Authorization requires the following
832
839
  # [Google IAM](https://cloud.google.com/iam) permission on the specified
@@ -898,8 +905,8 @@ module Google
898
905
  end
899
906
 
900
907
  ##
901
- # Sets the access control policy for a {::Google::Cloud::Tasks::V2beta2::Queue Queue}. Replaces any existing
902
- # policy.
908
+ # Sets the access control policy for a
909
+ # {::Google::Cloud::Tasks::V2beta2::Queue Queue}. Replaces any existing policy.
903
910
  #
904
911
  # Note: The Cloud Console does not check queue-level IAM permissions yet.
905
912
  # Project-level permissions are required to use the Cloud Console.
@@ -982,9 +989,10 @@ module Google
982
989
  end
983
990
 
984
991
  ##
985
- # Returns permissions that a caller has on a {::Google::Cloud::Tasks::V2beta2::Queue Queue}.
986
- # If the resource does not exist, this will return an empty set of
987
- # permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
992
+ # Returns permissions that a caller has on a
993
+ # {::Google::Cloud::Tasks::V2beta2::Queue Queue}. If the resource does not exist,
994
+ # this will return an empty set of permissions, not a
995
+ # [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
988
996
  #
989
997
  # Note: This operation is designed to be used for building permission-aware
990
998
  # UIs and command-line tools, not for authorization checking. This operation
@@ -1058,10 +1066,10 @@ module Google
1058
1066
  ##
1059
1067
  # Lists the tasks in a queue.
1060
1068
  #
1061
- # By default, only the {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC} view is retrieved
1062
- # due to performance considerations;
1063
- # {::Google::Cloud::Tasks::V2beta2::ListTasksRequest#response_view response_view} controls the
1064
- # subset of information which is returned.
1069
+ # By default, only the {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}
1070
+ # view is retrieved due to performance considerations;
1071
+ # {::Google::Cloud::Tasks::V2beta2::ListTasksRequest#response_view response_view}
1072
+ # controls the subset of information which is returned.
1065
1073
  #
1066
1074
  # The tasks may be returned in any order. The ordering may change at any
1067
1075
  # time.
@@ -1085,24 +1093,25 @@ module Google
1085
1093
  # Required. The queue name. For example:
1086
1094
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
1087
1095
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1088
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1089
- # returned.
1090
- #
1091
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1092
- # information is retrieved by default because some data, such as
1093
- # payloads, might be desirable to return only when needed because
1094
- # of its large size or because of the sensitivity of data that it
1095
- # contains.
1096
- #
1097
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1098
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1099
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1096
+ # The response_view specifies which subset of the
1097
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1098
+ #
1099
+ # By default response_view is
1100
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1101
+ # retrieved by default because some data, such as payloads, might be
1102
+ # desirable to return only when needed because of its large size or because
1103
+ # of the sensitivity of data that it contains.
1104
+ #
1105
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1106
+ # requires `cloudtasks.tasks.fullView` [Google
1107
+ # IAM](https://cloud.google.com/iam/) permission on the
1108
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1100
1109
  # @param page_size [::Integer]
1101
1110
  # Maximum page size.
1102
1111
  #
1103
1112
  # Fewer tasks than requested might be returned, even if more tasks exist; use
1104
- # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token} in the response to
1105
- # determine if more tasks exist.
1113
+ # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
1114
+ # in the response to determine if more tasks exist.
1106
1115
  #
1107
1116
  # The maximum page size is 1000. If unspecified, the page size will be the
1108
1117
  # maximum.
@@ -1111,9 +1120,9 @@ module Google
1111
1120
  #
1112
1121
  # To request the first page results, page_token must be empty. To
1113
1122
  # request the next page of results, page_token must be the value of
1114
- # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token} returned
1115
- # from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#list_tasks ListTasks}
1116
- # method.
1123
+ # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
1124
+ # returned from the previous call to
1125
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#list_tasks ListTasks} method.
1117
1126
  #
1118
1127
  # The page token is valid for only 2 hours.
1119
1128
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -1181,18 +1190,19 @@ module Google
1181
1190
  # Required. The task name. For example:
1182
1191
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
1183
1192
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1184
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1185
- # returned.
1186
- #
1187
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1188
- # information is retrieved by default because some data, such as
1189
- # payloads, might be desirable to return only when needed because
1190
- # of its large size or because of the sensitivity of data that it
1191
- # contains.
1192
- #
1193
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1194
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1195
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1193
+ # The response_view specifies which subset of the
1194
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1195
+ #
1196
+ # By default response_view is
1197
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1198
+ # retrieved by default because some data, such as payloads, might be
1199
+ # desirable to return only when needed because of its large size or because
1200
+ # of the sensitivity of data that it contains.
1201
+ #
1202
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1203
+ # requires `cloudtasks.tasks.fullView` [Google
1204
+ # IAM](https://cloud.google.com/iam/) permission on the
1205
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1196
1206
  # @yield [result, operation] Access the result along with the TransportOperation object
1197
1207
  # @yieldparam result [::Google::Cloud::Tasks::V2beta2::Task]
1198
1208
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1240,9 +1250,11 @@ module Google
1240
1250
  #
1241
1251
  # Tasks cannot be updated after creation; there is no UpdateTask command.
1242
1252
  #
1243
- # * For {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues}, the maximum task size is
1253
+ # * For {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues},
1254
+ # the maximum task size is
1244
1255
  # 100KB.
1245
- # * For {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}, the maximum task size is 1MB.
1256
+ # * For {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}, the maximum
1257
+ # task size is 1MB.
1246
1258
  #
1247
1259
  # @overload create_task(request, options = nil)
1248
1260
  # Pass arguments to `create_task` via a request object, either of type
@@ -1269,13 +1281,13 @@ module Google
1269
1281
  #
1270
1282
  # Task names have the following format:
1271
1283
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
1272
- # The user can optionally specify a task {::Google::Cloud::Tasks::V2beta2::Task#name name}. If a
1273
- # name is not specified then the system will generate a random
1274
- # unique task id, which will be set in the task returned in the
1275
- # {::Google::Cloud::Tasks::V2beta2::Task#name response}.
1284
+ # The user can optionally specify a task
1285
+ # {::Google::Cloud::Tasks::V2beta2::Task#name name}. If a name is not specified
1286
+ # then the system will generate a random unique task id, which will be set in
1287
+ # the task returned in the {::Google::Cloud::Tasks::V2beta2::Task#name response}.
1276
1288
  #
1277
- # If {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not set or is in the
1278
- # past then Cloud Tasks will set it to the current time.
1289
+ # If {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not
1290
+ # set or is in the past then Cloud Tasks will set it to the current time.
1279
1291
  #
1280
1292
  # Task De-duplication:
1281
1293
  #
@@ -1290,27 +1302,28 @@ module Google
1290
1302
  # for ~9days after the original task was deleted or completed.
1291
1303
  #
1292
1304
  # Because there is an extra lookup cost to identify duplicate task
1293
- # names, these {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#create_task CreateTask} calls have significantly
1294
- # increased latency. Using hashed strings for the task id or for
1295
- # the prefix of the task id is recommended. Choosing task ids that
1296
- # are sequential or have sequential prefixes, for example using a
1305
+ # names, these {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#create_task CreateTask}
1306
+ # calls have significantly increased latency. Using hashed strings for the
1307
+ # task id or for the prefix of the task id is recommended. Choosing task ids
1308
+ # that are sequential or have sequential prefixes, for example using a
1297
1309
  # timestamp, causes an increase in latency and error rates in all
1298
1310
  # task commands. The infrastructure relies on an approximately
1299
1311
  # uniform distribution of task ids to store and serve tasks
1300
1312
  # efficiently.
1301
1313
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1302
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1303
- # returned.
1304
- #
1305
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1306
- # information is retrieved by default because some data, such as
1307
- # payloads, might be desirable to return only when needed because
1308
- # of its large size or because of the sensitivity of data that it
1309
- # contains.
1310
- #
1311
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1312
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1313
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1314
+ # The response_view specifies which subset of the
1315
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1316
+ #
1317
+ # By default response_view is
1318
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1319
+ # retrieved by default because some data, such as payloads, might be
1320
+ # desirable to return only when needed because of its large size or because
1321
+ # of the sensitivity of data that it contains.
1322
+ #
1323
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1324
+ # requires `cloudtasks.tasks.fullView` [Google
1325
+ # IAM](https://cloud.google.com/iam/) permission on the
1326
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1314
1327
  # @yield [result, operation] Access the result along with the TransportOperation object
1315
1328
  # @yieldparam result [::Google::Cloud::Tasks::V2beta2::Task]
1316
1329
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1426,18 +1439,19 @@ module Google
1426
1439
  #
1427
1440
  # This method is invoked by the worker to obtain a lease. The
1428
1441
  # worker must acknowledge the task via
1429
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#acknowledge_task AcknowledgeTask} after they have
1430
- # performed the work associated with the task.
1431
- #
1432
- # The {::Google::Cloud::Tasks::V2beta2::PullMessage#payload payload} is intended to store data that
1433
- # the worker needs to perform the work associated with the task. To
1434
- # return the payloads in the {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response}, set
1435
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#response_view response_view} to
1436
- # {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}.
1437
- #
1438
- # A maximum of 10 qps of {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks}
1439
- # requests are allowed per
1440
- # queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
1442
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#acknowledge_task AcknowledgeTask}
1443
+ # after they have performed the work associated with the task.
1444
+ #
1445
+ # The {::Google::Cloud::Tasks::V2beta2::PullMessage#payload payload} is intended
1446
+ # to store data that the worker needs to perform the work associated with the
1447
+ # task. To return the payloads in the
1448
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response}, set
1449
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#response_view response_view}
1450
+ # to {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}.
1451
+ #
1452
+ # A maximum of 10 qps of
1453
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks} requests are
1454
+ # allowed per queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
1441
1455
  # is returned when this limit is
1442
1456
  # exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
1443
1457
  # is also returned when
@@ -1470,53 +1484,59 @@ module Google
1470
1484
  #
1471
1485
  # The largest that `max_tasks` can be is 1000.
1472
1486
  #
1473
- # The maximum total size of a {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse lease tasks response} is
1474
- # 32 MB. If the sum of all task sizes requested reaches this limit,
1475
- # fewer tasks than requested are returned.
1487
+ # The maximum total size of a [lease tasks
1488
+ # response][google.cloud.tasks.v2beta2.LeaseTasksResponse] is 32 MB. If the
1489
+ # sum of all task sizes requested reaches this limit, fewer tasks than
1490
+ # requested are returned.
1476
1491
  # @param lease_duration [::Google::Protobuf::Duration, ::Hash]
1477
1492
  # Required. The duration of the lease.
1478
1493
  #
1479
- # Each task returned in the {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will
1480
- # have its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} set to the current
1481
- # time plus the `lease_duration`. The task is leased until its
1482
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}; thus, the task will not be
1483
- # returned to another {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks} call
1484
- # before its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
1494
+ # Each task returned in the
1495
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will have its
1496
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} set to the
1497
+ # current time plus the `lease_duration`. The task is leased until its
1498
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}; thus, the
1499
+ # task will not be returned to another
1500
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks} call before
1501
+ # its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
1485
1502
  #
1486
1503
  #
1487
1504
  # After the worker has successfully finished the work associated
1488
1505
  # with the task, the worker must call via
1489
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#acknowledge_task AcknowledgeTask} before the
1490
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}. Otherwise the task will be
1491
- # returned to a later {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks} call so
1492
- # that another worker can retry it.
1506
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#acknowledge_task AcknowledgeTask}
1507
+ # before the {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
1508
+ # Otherwise the task will be returned to a later
1509
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks} call so that
1510
+ # another worker can retry it.
1493
1511
  #
1494
1512
  # The maximum lease duration is 1 week.
1495
1513
  # `lease_duration` will be truncated to the nearest second.
1496
1514
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1497
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1498
- # returned.
1499
- #
1500
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1501
- # information is retrieved by default because some data, such as
1502
- # payloads, might be desirable to return only when needed because
1503
- # of its large size or because of the sensitivity of data that it
1504
- # contains.
1505
- #
1506
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1507
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1508
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1515
+ # The response_view specifies which subset of the
1516
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1517
+ #
1518
+ # By default response_view is
1519
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1520
+ # retrieved by default because some data, such as payloads, might be
1521
+ # desirable to return only when needed because of its large size or because
1522
+ # of the sensitivity of data that it contains.
1523
+ #
1524
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1525
+ # requires `cloudtasks.tasks.fullView` [Google
1526
+ # IAM](https://cloud.google.com/iam/) permission on the
1527
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1509
1528
  # @param filter [::String]
1510
1529
  # `filter` can be used to specify a subset of tasks to lease.
1511
1530
  #
1512
1531
  # When `filter` is set to `tag=<my-tag>` then the
1513
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only tasks whose
1514
- # {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to `<my-tag>`. `<my-tag>` must be
1515
- # less than 500 characters.
1532
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only
1533
+ # tasks whose {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to
1534
+ # `<my-tag>`. `<my-tag>` must be less than 500 characters.
1516
1535
  #
1517
1536
  # When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
1518
1537
  # the same tag as the task with the oldest
1519
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be returned.
1538
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
1539
+ # returned.
1520
1540
  #
1521
1541
  # Grammar Syntax:
1522
1542
  #
@@ -1534,8 +1554,9 @@ module Google
1534
1554
  # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
1535
1555
  # only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
1536
1556
  # aren't UTF-8 encoded can't be used in the
1537
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the task's
1538
- # {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed as empty in Cloud Tasks.
1557
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the
1558
+ # task's {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed
1559
+ # as empty in Cloud Tasks.
1539
1560
  # @yield [result, operation] Access the result along with the TransportOperation object
1540
1561
  # @yieldparam result [::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse]
1541
1562
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1582,12 +1603,13 @@ module Google
1582
1603
  # Acknowledges a pull task.
1583
1604
  #
1584
1605
  # The worker, that is, the entity that
1585
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks leased} this task must call this method
1586
- # to indicate that the work associated with the task has finished.
1606
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks leased} this task must
1607
+ # call this method to indicate that the work associated with the task has
1608
+ # finished.
1587
1609
  #
1588
1610
  # The worker must acknowledge a task within the
1589
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#lease_duration lease_duration} or the lease
1590
- # will expire and the task will become available to be leased
1611
+ # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#lease_duration lease_duration}
1612
+ # or the lease will expire and the task will become available to be leased
1591
1613
  # again. After the task is acknowledged, it will not be returned
1592
1614
  # by a later {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks},
1593
1615
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#get_task GetTask}, or
@@ -1615,8 +1637,8 @@ module Google
1615
1637
  # Required. The task's current schedule time, available in the
1616
1638
  # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
1617
1639
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks} response or
1618
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#renew_lease RenewLease} response. This restriction is
1619
- # to ensure that your worker currently holds the lease.
1640
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#renew_lease RenewLease} response.
1641
+ # This restriction is to ensure that your worker currently holds the lease.
1620
1642
  # @yield [result, operation] Access the result along with the TransportOperation object
1621
1643
  # @yieldparam result [::Google::Protobuf::Empty]
1622
1644
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1664,7 +1686,8 @@ module Google
1664
1686
  #
1665
1687
  # The worker can use this method to extend the lease by a new
1666
1688
  # duration, starting from now. The new task lease will be
1667
- # returned in the task's {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
1689
+ # returned in the task's
1690
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
1668
1691
  #
1669
1692
  # @overload renew_lease(request, options = nil)
1670
1693
  # Pass arguments to `renew_lease` via a request object, either of type
@@ -1688,8 +1711,8 @@ module Google
1688
1711
  # Required. The task's current schedule time, available in the
1689
1712
  # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
1690
1713
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks} response or
1691
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#renew_lease RenewLease} response. This restriction is
1692
- # to ensure that your worker currently holds the lease.
1714
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#renew_lease RenewLease} response.
1715
+ # This restriction is to ensure that your worker currently holds the lease.
1693
1716
  # @param lease_duration [::Google::Protobuf::Duration, ::Hash]
1694
1717
  # Required. The desired new lease duration, starting from now.
1695
1718
  #
@@ -1697,18 +1720,19 @@ module Google
1697
1720
  # The maximum lease duration is 1 week.
1698
1721
  # `lease_duration` will be truncated to the nearest second.
1699
1722
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1700
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1701
- # returned.
1702
- #
1703
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1704
- # information is retrieved by default because some data, such as
1705
- # payloads, might be desirable to return only when needed because
1706
- # of its large size or because of the sensitivity of data that it
1707
- # contains.
1708
- #
1709
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1710
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1711
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1723
+ # The response_view specifies which subset of the
1724
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1725
+ #
1726
+ # By default response_view is
1727
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1728
+ # retrieved by default because some data, such as payloads, might be
1729
+ # desirable to return only when needed because of its large size or because
1730
+ # of the sensitivity of data that it contains.
1731
+ #
1732
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1733
+ # requires `cloudtasks.tasks.fullView` [Google
1734
+ # IAM](https://cloud.google.com/iam/) permission on the
1735
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1712
1736
  # @yield [result, operation] Access the result along with the TransportOperation object
1713
1737
  # @yieldparam result [::Google::Cloud::Tasks::V2beta2::Task]
1714
1738
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1755,9 +1779,9 @@ module Google
1755
1779
  # Cancel a pull task's lease.
1756
1780
  #
1757
1781
  # The worker can use this method to cancel a task's lease by
1758
- # setting its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} to now. This will
1759
- # make the task available to be leased to the next caller of
1760
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks}.
1782
+ # setting its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}
1783
+ # to now. This will make the task available to be leased to the next caller
1784
+ # of {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks}.
1761
1785
  #
1762
1786
  # @overload cancel_lease(request, options = nil)
1763
1787
  # Pass arguments to `cancel_lease` via a request object, either of type
@@ -1781,21 +1805,22 @@ module Google
1781
1805
  # Required. The task's current schedule time, available in the
1782
1806
  # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
1783
1807
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#lease_tasks LeaseTasks} response or
1784
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#renew_lease RenewLease} response. This restriction is
1785
- # to ensure that your worker currently holds the lease.
1808
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#renew_lease RenewLease} response.
1809
+ # This restriction is to ensure that your worker currently holds the lease.
1786
1810
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1787
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1788
- # returned.
1789
- #
1790
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1791
- # information is retrieved by default because some data, such as
1792
- # payloads, might be desirable to return only when needed because
1793
- # of its large size or because of the sensitivity of data that it
1794
- # contains.
1795
- #
1796
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1797
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1798
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1811
+ # The response_view specifies which subset of the
1812
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1813
+ #
1814
+ # By default response_view is
1815
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1816
+ # retrieved by default because some data, such as payloads, might be
1817
+ # desirable to return only when needed because of its large size or because
1818
+ # of the sensitivity of data that it contains.
1819
+ #
1820
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1821
+ # requires `cloudtasks.tasks.fullView` [Google
1822
+ # IAM](https://cloud.google.com/iam/) permission on the
1823
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1799
1824
  # @yield [result, operation] Access the result along with the TransportOperation object
1800
1825
  # @yieldparam result [::Google::Cloud::Tasks::V2beta2::Task]
1801
1826
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1842,30 +1867,33 @@ module Google
1842
1867
  # Forces a task to run now.
1843
1868
  #
1844
1869
  # When this method is called, Cloud Tasks will dispatch the task, even if
1845
- # the task is already running, the queue has reached its {::Google::Cloud::Tasks::V2beta2::RateLimits RateLimits} or
1846
- # is {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
1870
+ # the task is already running, the queue has reached its
1871
+ # {::Google::Cloud::Tasks::V2beta2::RateLimits RateLimits} or is
1872
+ # {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
1847
1873
  #
1848
1874
  # This command is meant to be used for manual debugging. For
1849
- # example, {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#run_task RunTask} can be used to retry a failed
1850
- # task after a fix has been made or to manually force a task to be
1851
- # dispatched now.
1875
+ # example, {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#run_task RunTask} can be
1876
+ # used to retry a failed task after a fix has been made or to manually force
1877
+ # a task to be dispatched now.
1852
1878
  #
1853
1879
  # The dispatched task is returned. That is, the task that is returned
1854
- # contains the {::Google::Cloud::Tasks::V2beta2::Task#status status} after the task is dispatched but
1855
- # before the task is received by its target.
1880
+ # contains the {::Google::Cloud::Tasks::V2beta2::Task#status status} after the
1881
+ # task is dispatched but before the task is received by its target.
1856
1882
  #
1857
1883
  # If Cloud Tasks receives a successful response from the task's
1858
1884
  # target, then the task will be deleted; otherwise the task's
1859
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be reset to the time that
1860
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#run_task RunTask} was called plus the retry delay specified
1861
- # in the queue's {::Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig}.
1885
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
1886
+ # reset to the time that
1887
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#run_task RunTask} was called plus
1888
+ # the retry delay specified in the queue's
1889
+ # {::Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig}.
1862
1890
  #
1863
1891
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#run_task RunTask} returns
1864
1892
  # [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
1865
1893
  # task that has already succeeded or permanently failed.
1866
1894
  #
1867
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#run_task RunTask} cannot be called on a
1868
- # {::Google::Cloud::Tasks::V2beta2::PullMessage pull task}.
1895
+ # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#run_task RunTask} cannot be called
1896
+ # on a {::Google::Cloud::Tasks::V2beta2::PullMessage pull task}.
1869
1897
  #
1870
1898
  # @overload run_task(request, options = nil)
1871
1899
  # Pass arguments to `run_task` via a request object, either of type
@@ -1886,18 +1914,19 @@ module Google
1886
1914
  # Required. The task name. For example:
1887
1915
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
1888
1916
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1889
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1890
- # returned.
1891
- #
1892
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1893
- # information is retrieved by default because some data, such as
1894
- # payloads, might be desirable to return only when needed because
1895
- # of its large size or because of the sensitivity of data that it
1896
- # contains.
1897
- #
1898
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1899
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1900
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1917
+ # The response_view specifies which subset of the
1918
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1919
+ #
1920
+ # By default response_view is
1921
+ # {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
1922
+ # retrieved by default because some data, such as payloads, might be
1923
+ # desirable to return only when needed because of its large size or because
1924
+ # of the sensitivity of data that it contains.
1925
+ #
1926
+ # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
1927
+ # requires `cloudtasks.tasks.fullView` [Google
1928
+ # IAM](https://cloud.google.com/iam/) permission on the
1929
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
1901
1930
  # @yield [result, operation] Access the result along with the TransportOperation object
1902
1931
  # @yieldparam result [::Google::Cloud::Tasks::V2beta2::Task]
1903
1932
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1978,9 +2007,9 @@ module Google
1978
2007
  # * (`String`) The path to a service account key file in JSON format
1979
2008
  # * (`Hash`) A service account key as a Hash
1980
2009
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1981
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
2010
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1982
2011
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1983
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
2012
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1984
2013
  # * (`nil`) indicating no credentials
1985
2014
  # @return [::Object]
1986
2015
  # @!attribute [rw] scope