google-cloud-tasks-v2beta2 0.8.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.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/client.rb +219 -190
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/rest/client.rb +229 -200
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +29 -87
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +68 -56
- data/lib/google/cloud/tasks/v2beta2/queue_pb.rb +27 -43
- data/lib/google/cloud/tasks/v2beta2/target_pb.rb +24 -31
- data/lib/google/cloud/tasks/v2beta2/task_pb.rb +27 -29
- data/lib/google/cloud/tasks/v2beta2/version.rb +1 -1
- data/proto_docs/google/api/client.rb +67 -4
- data/proto_docs/google/cloud/tasks/v2beta2/cloudtasks.rb +193 -159
- data/proto_docs/google/cloud/tasks/v2beta2/queue.rb +97 -73
- data/proto_docs/google/cloud/tasks/v2beta2/target.rb +88 -63
- data/proto_docs/google/cloud/tasks/v2beta2/task.rb +41 -24
- data/proto_docs/google/iam/v1/policy.rb +8 -4
- data/proto_docs/google/protobuf/any.rb +7 -4
- data/proto_docs/google/protobuf/timestamp.rb +1 -3
- metadata +4 -4
|
@@ -233,11 +233,10 @@ module Google
|
|
|
233
233
|
# Required. The location name.
|
|
234
234
|
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
|
235
235
|
# @param filter [::String]
|
|
236
|
-
# `filter` can be used to specify a subset of queues. Any
|
|
237
|
-
# field can be used as a filter and
|
|
238
|
-
# For example: `<=, <, >=, >, !=, =, :`. The
|
|
239
|
-
# described in
|
|
240
|
-
# [Stackdriver's Advanced Logs
|
|
236
|
+
# `filter` can be used to specify a subset of queues. Any
|
|
237
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue Queue} field can be used as a filter and
|
|
238
|
+
# several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
|
|
239
|
+
# filter syntax is the same as described in [Stackdriver's Advanced Logs
|
|
241
240
|
# Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
|
|
242
241
|
#
|
|
243
242
|
# Sample filter "app_engine_http_target: *".
|
|
@@ -250,20 +249,22 @@ module Google
|
|
|
250
249
|
# The maximum page size is 9800. If unspecified, the page size will
|
|
251
250
|
# be the maximum. Fewer queues than requested might be returned,
|
|
252
251
|
# even if more queues exist; use the
|
|
253
|
-
# {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
|
|
254
|
-
# response to determine if more queues exist.
|
|
252
|
+
# {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
|
|
253
|
+
# in the response to determine if more queues exist.
|
|
255
254
|
# @param page_token [::String]
|
|
256
255
|
# A token identifying the page of results to return.
|
|
257
256
|
#
|
|
258
257
|
# To request the first page results, page_token must be empty. To
|
|
259
258
|
# request the next page of results, page_token must be the value of
|
|
260
|
-
# {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
|
|
261
|
-
# from the previous call to
|
|
262
|
-
# method. It
|
|
263
|
-
#
|
|
259
|
+
# {::Google::Cloud::Tasks::V2beta2::ListQueuesResponse#next_page_token next_page_token}
|
|
260
|
+
# returned from the previous call to
|
|
261
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues} method. It
|
|
262
|
+
# is an error to switch the value of the
|
|
263
|
+
# {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while
|
|
264
|
+
# iterating through pages.
|
|
264
265
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
265
|
-
# Optional. Read mask is used for a more granular control over what the API
|
|
266
|
-
# If the mask is not present all fields will be returned except
|
|
266
|
+
# Optional. Read mask is used for a more granular control over what the API
|
|
267
|
+
# returns. If the mask is not present all fields will be returned except
|
|
267
268
|
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
|
268
269
|
# specified in the mask.
|
|
269
270
|
#
|
|
@@ -358,8 +359,8 @@ module Google
|
|
|
358
359
|
# Required. The resource name of the queue. For example:
|
|
359
360
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
|
360
361
|
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
361
|
-
# Optional. Read mask is used for a more granular control over what the API
|
|
362
|
-
# If the mask is not present all fields will be returned except
|
|
362
|
+
# Optional. Read mask is used for a more granular control over what the API
|
|
363
|
+
# returns. If the mask is not present all fields will be returned except
|
|
363
364
|
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
|
364
365
|
# specified in the mask.
|
|
365
366
|
#
|
|
@@ -431,8 +432,8 @@ module Google
|
|
|
431
432
|
# Creates a queue.
|
|
432
433
|
#
|
|
433
434
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
434
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
435
|
-
# it was dispatched or not.
|
|
435
|
+
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
436
|
+
# whether it was dispatched or not.
|
|
436
437
|
#
|
|
437
438
|
# WARNING: Using this method may have unintended side effects if you are
|
|
438
439
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
@@ -466,7 +467,8 @@ module Google
|
|
|
466
467
|
# @param queue [::Google::Cloud::Tasks::V2beta2::Queue, ::Hash]
|
|
467
468
|
# Required. The queue to create.
|
|
468
469
|
#
|
|
469
|
-
# [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as
|
|
470
|
+
# [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as
|
|
471
|
+
# an existing queue.
|
|
470
472
|
#
|
|
471
473
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
472
474
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta2::Queue]
|
|
@@ -539,8 +541,8 @@ module Google
|
|
|
539
541
|
# the queue if it does exist.
|
|
540
542
|
#
|
|
541
543
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
542
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
543
|
-
# it was dispatched or not.
|
|
544
|
+
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
545
|
+
# whether it was dispatched or not.
|
|
544
546
|
#
|
|
545
547
|
# WARNING: Using this method may have unintended side effects if you are
|
|
546
548
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
@@ -567,11 +569,13 @@ module Google
|
|
|
567
569
|
# @param queue [::Google::Cloud::Tasks::V2beta2::Queue, ::Hash]
|
|
568
570
|
# Required. The queue to create or update.
|
|
569
571
|
#
|
|
570
|
-
# The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} must be
|
|
572
|
+
# The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} must be
|
|
573
|
+
# specified.
|
|
571
574
|
#
|
|
572
575
|
# Output only fields cannot be modified using UpdateQueue.
|
|
573
576
|
# Any value specified for an output only field will be ignored.
|
|
574
|
-
# The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be
|
|
577
|
+
# The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be
|
|
578
|
+
# changed.
|
|
575
579
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
576
580
|
# A mask used to specify which fields of the queue are being updated.
|
|
577
581
|
#
|
|
@@ -835,9 +839,10 @@ module Google
|
|
|
835
839
|
#
|
|
836
840
|
# If a queue is paused then the system will stop dispatching tasks
|
|
837
841
|
# until the queue is resumed via
|
|
838
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#resume_queue ResumeQueue}. Tasks can
|
|
839
|
-
# when the queue is paused. A queue is paused if its
|
|
840
|
-
# {::Google::Cloud::Tasks::V2beta2::Queue#state state} is
|
|
842
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#resume_queue ResumeQueue}. Tasks can
|
|
843
|
+
# still be added when the queue is paused. A queue is paused if its
|
|
844
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue#state state} is
|
|
845
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
|
|
841
846
|
#
|
|
842
847
|
# @overload pause_queue(request, options = nil)
|
|
843
848
|
# Pass arguments to `pause_queue` via a request object, either of type
|
|
@@ -927,9 +932,11 @@ module Google
|
|
|
927
932
|
#
|
|
928
933
|
# This method resumes a queue after it has been
|
|
929
934
|
# {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED} or
|
|
930
|
-
# {::Google::Cloud::Tasks::V2beta2::Queue::State::DISABLED DISABLED}. The state of a
|
|
931
|
-
# in the queue's
|
|
932
|
-
#
|
|
935
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue::State::DISABLED DISABLED}. The state of a
|
|
936
|
+
# queue is stored in the queue's
|
|
937
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue#state state}; after calling this method
|
|
938
|
+
# it will be set to
|
|
939
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue::State::RUNNING RUNNING}.
|
|
933
940
|
#
|
|
934
941
|
# WARNING: Resuming many high-QPS queues at the same time can
|
|
935
942
|
# lead to target overloading. If you are resuming high-QPS
|
|
@@ -1021,9 +1028,9 @@ module Google
|
|
|
1021
1028
|
end
|
|
1022
1029
|
|
|
1023
1030
|
##
|
|
1024
|
-
# Gets the access control policy for a
|
|
1025
|
-
# Returns an empty policy if the
|
|
1026
|
-
# set.
|
|
1031
|
+
# Gets the access control policy for a
|
|
1032
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue Queue}. Returns an empty policy if the
|
|
1033
|
+
# resource exists and does not have a policy set.
|
|
1027
1034
|
#
|
|
1028
1035
|
# Authorization requires the following
|
|
1029
1036
|
# [Google IAM](https://cloud.google.com/iam) permission on the specified
|
|
@@ -1118,8 +1125,8 @@ module Google
|
|
|
1118
1125
|
end
|
|
1119
1126
|
|
|
1120
1127
|
##
|
|
1121
|
-
# Sets the access control policy for a
|
|
1122
|
-
# policy.
|
|
1128
|
+
# Sets the access control policy for a
|
|
1129
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue Queue}. Replaces any existing policy.
|
|
1123
1130
|
#
|
|
1124
1131
|
# Note: The Cloud Console does not check queue-level IAM permissions yet.
|
|
1125
1132
|
# Project-level permissions are required to use the Cloud Console.
|
|
@@ -1225,9 +1232,10 @@ module Google
|
|
|
1225
1232
|
end
|
|
1226
1233
|
|
|
1227
1234
|
##
|
|
1228
|
-
# Returns permissions that a caller has on a
|
|
1229
|
-
# If the resource does not exist,
|
|
1230
|
-
# permissions, not a
|
|
1235
|
+
# Returns permissions that a caller has on a
|
|
1236
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue Queue}. If the resource does not exist,
|
|
1237
|
+
# this will return an empty set of permissions, not a
|
|
1238
|
+
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
|
|
1231
1239
|
#
|
|
1232
1240
|
# Note: This operation is designed to be used for building permission-aware
|
|
1233
1241
|
# UIs and command-line tools, not for authorization checking. This operation
|
|
@@ -1324,10 +1332,10 @@ module Google
|
|
|
1324
1332
|
##
|
|
1325
1333
|
# Lists the tasks in a queue.
|
|
1326
1334
|
#
|
|
1327
|
-
# By default, only the {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}
|
|
1328
|
-
# due to performance considerations;
|
|
1329
|
-
# {::Google::Cloud::Tasks::V2beta2::ListTasksRequest#response_view response_view}
|
|
1330
|
-
# subset of information which is returned.
|
|
1335
|
+
# By default, only the {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}
|
|
1336
|
+
# view is retrieved due to performance considerations;
|
|
1337
|
+
# {::Google::Cloud::Tasks::V2beta2::ListTasksRequest#response_view response_view}
|
|
1338
|
+
# controls the subset of information which is returned.
|
|
1331
1339
|
#
|
|
1332
1340
|
# The tasks may be returned in any order. The ordering may change at any
|
|
1333
1341
|
# time.
|
|
@@ -1351,24 +1359,25 @@ module Google
|
|
|
1351
1359
|
# Required. The queue name. For example:
|
|
1352
1360
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
|
1353
1361
|
# @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
|
|
1354
|
-
# The response_view specifies which subset of the
|
|
1355
|
-
# returned.
|
|
1356
|
-
#
|
|
1357
|
-
# By default response_view is
|
|
1358
|
-
#
|
|
1359
|
-
#
|
|
1360
|
-
#
|
|
1361
|
-
# contains.
|
|
1362
|
-
#
|
|
1363
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
1364
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
1365
|
-
# permission on the
|
|
1362
|
+
# The response_view specifies which subset of the
|
|
1363
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
1364
|
+
#
|
|
1365
|
+
# By default response_view is
|
|
1366
|
+
# {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
1367
|
+
# retrieved by default because some data, such as payloads, might be
|
|
1368
|
+
# desirable to return only when needed because of its large size or because
|
|
1369
|
+
# of the sensitivity of data that it contains.
|
|
1370
|
+
#
|
|
1371
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
1372
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
1373
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
1374
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
1366
1375
|
# @param page_size [::Integer]
|
|
1367
1376
|
# Maximum page size.
|
|
1368
1377
|
#
|
|
1369
1378
|
# Fewer tasks than requested might be returned, even if more tasks exist; use
|
|
1370
|
-
# {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
|
|
1371
|
-
# determine if more tasks exist.
|
|
1379
|
+
# {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
|
|
1380
|
+
# in the response to determine if more tasks exist.
|
|
1372
1381
|
#
|
|
1373
1382
|
# The maximum page size is 1000. If unspecified, the page size will be the
|
|
1374
1383
|
# maximum.
|
|
@@ -1377,9 +1386,9 @@ module Google
|
|
|
1377
1386
|
#
|
|
1378
1387
|
# To request the first page results, page_token must be empty. To
|
|
1379
1388
|
# request the next page of results, page_token must be the value of
|
|
1380
|
-
# {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
|
|
1381
|
-
# from the previous call to
|
|
1382
|
-
# method.
|
|
1389
|
+
# {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token}
|
|
1390
|
+
# returned from the previous call to
|
|
1391
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks} method.
|
|
1383
1392
|
#
|
|
1384
1393
|
# The page token is valid for only 2 hours.
|
|
1385
1394
|
#
|
|
@@ -1474,18 +1483,19 @@ module Google
|
|
|
1474
1483
|
# Required. The task name. For example:
|
|
1475
1484
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
|
1476
1485
|
# @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
|
|
1477
|
-
# The response_view specifies which subset of the
|
|
1478
|
-
# returned.
|
|
1486
|
+
# The response_view specifies which subset of the
|
|
1487
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
1479
1488
|
#
|
|
1480
|
-
# By default response_view is
|
|
1481
|
-
#
|
|
1482
|
-
#
|
|
1483
|
-
#
|
|
1484
|
-
# contains.
|
|
1489
|
+
# By default response_view is
|
|
1490
|
+
# {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
1491
|
+
# retrieved by default because some data, such as payloads, might be
|
|
1492
|
+
# desirable to return only when needed because of its large size or because
|
|
1493
|
+
# of the sensitivity of data that it contains.
|
|
1485
1494
|
#
|
|
1486
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
1487
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
1488
|
-
# permission on the
|
|
1495
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
1496
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
1497
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
1498
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
1489
1499
|
#
|
|
1490
1500
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1491
1501
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
|
|
@@ -1556,9 +1566,11 @@ module Google
|
|
|
1556
1566
|
#
|
|
1557
1567
|
# Tasks cannot be updated after creation; there is no UpdateTask command.
|
|
1558
1568
|
#
|
|
1559
|
-
# * For {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues},
|
|
1569
|
+
# * For {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues},
|
|
1570
|
+
# the maximum task size is
|
|
1560
1571
|
# 100KB.
|
|
1561
|
-
# * For {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}, the maximum
|
|
1572
|
+
# * For {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}, the maximum
|
|
1573
|
+
# task size is 1MB.
|
|
1562
1574
|
#
|
|
1563
1575
|
# @overload create_task(request, options = nil)
|
|
1564
1576
|
# Pass arguments to `create_task` via a request object, either of type
|
|
@@ -1585,13 +1597,13 @@ module Google
|
|
|
1585
1597
|
#
|
|
1586
1598
|
# Task names have the following format:
|
|
1587
1599
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
|
|
1588
|
-
# The user can optionally specify a task
|
|
1589
|
-
# name
|
|
1590
|
-
# unique task id, which will be set in
|
|
1591
|
-
# {::Google::Cloud::Tasks::V2beta2::Task#name response}.
|
|
1600
|
+
# The user can optionally specify a task
|
|
1601
|
+
# {::Google::Cloud::Tasks::V2beta2::Task#name name}. If a name is not specified
|
|
1602
|
+
# then the system will generate a random unique task id, which will be set in
|
|
1603
|
+
# the task returned in the {::Google::Cloud::Tasks::V2beta2::Task#name response}.
|
|
1592
1604
|
#
|
|
1593
|
-
# If {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not
|
|
1594
|
-
# past then Cloud Tasks will set it to the current time.
|
|
1605
|
+
# If {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not
|
|
1606
|
+
# set or is in the past then Cloud Tasks will set it to the current time.
|
|
1595
1607
|
#
|
|
1596
1608
|
# Task De-duplication:
|
|
1597
1609
|
#
|
|
@@ -1606,27 +1618,28 @@ module Google
|
|
|
1606
1618
|
# for ~9days after the original task was deleted or completed.
|
|
1607
1619
|
#
|
|
1608
1620
|
# Because there is an extra lookup cost to identify duplicate task
|
|
1609
|
-
# names, these {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask}
|
|
1610
|
-
# increased latency. Using hashed strings for the
|
|
1611
|
-
# the prefix of the task id is recommended. Choosing task ids
|
|
1612
|
-
# are sequential or have sequential prefixes, for example using a
|
|
1621
|
+
# names, these {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask}
|
|
1622
|
+
# calls have significantly increased latency. Using hashed strings for the
|
|
1623
|
+
# task id or for the prefix of the task id is recommended. Choosing task ids
|
|
1624
|
+
# that are sequential or have sequential prefixes, for example using a
|
|
1613
1625
|
# timestamp, causes an increase in latency and error rates in all
|
|
1614
1626
|
# task commands. The infrastructure relies on an approximately
|
|
1615
1627
|
# uniform distribution of task ids to store and serve tasks
|
|
1616
1628
|
# efficiently.
|
|
1617
1629
|
# @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
|
|
1618
|
-
# The response_view specifies which subset of the
|
|
1619
|
-
# returned.
|
|
1630
|
+
# The response_view specifies which subset of the
|
|
1631
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
1620
1632
|
#
|
|
1621
|
-
# By default response_view is
|
|
1622
|
-
#
|
|
1623
|
-
#
|
|
1624
|
-
#
|
|
1625
|
-
# contains.
|
|
1633
|
+
# By default response_view is
|
|
1634
|
+
# {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
1635
|
+
# retrieved by default because some data, such as payloads, might be
|
|
1636
|
+
# desirable to return only when needed because of its large size or because
|
|
1637
|
+
# of the sensitivity of data that it contains.
|
|
1626
1638
|
#
|
|
1627
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
1628
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
1629
|
-
# permission on the
|
|
1639
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
1640
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
1641
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
1642
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
1630
1643
|
#
|
|
1631
1644
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1632
1645
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
|
|
@@ -1788,18 +1801,19 @@ module Google
|
|
|
1788
1801
|
#
|
|
1789
1802
|
# This method is invoked by the worker to obtain a lease. The
|
|
1790
1803
|
# worker must acknowledge the task via
|
|
1791
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask}
|
|
1792
|
-
# performed the work associated with the task.
|
|
1793
|
-
#
|
|
1794
|
-
# The {::Google::Cloud::Tasks::V2beta2::PullMessage#payload payload} is intended
|
|
1795
|
-
# the worker needs to perform the work associated with the
|
|
1796
|
-
# return the payloads in the
|
|
1797
|
-
# {::Google::Cloud::Tasks::V2beta2::
|
|
1798
|
-
# {::Google::Cloud::Tasks::V2beta2::
|
|
1799
|
-
#
|
|
1800
|
-
#
|
|
1801
|
-
#
|
|
1802
|
-
#
|
|
1804
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask}
|
|
1805
|
+
# after they have performed the work associated with the task.
|
|
1806
|
+
#
|
|
1807
|
+
# The {::Google::Cloud::Tasks::V2beta2::PullMessage#payload payload} is intended
|
|
1808
|
+
# to store data that the worker needs to perform the work associated with the
|
|
1809
|
+
# task. To return the payloads in the
|
|
1810
|
+
# {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response}, set
|
|
1811
|
+
# {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#response_view response_view}
|
|
1812
|
+
# to {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}.
|
|
1813
|
+
#
|
|
1814
|
+
# A maximum of 10 qps of
|
|
1815
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} requests are
|
|
1816
|
+
# allowed per queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
|
|
1803
1817
|
# is returned when this limit is
|
|
1804
1818
|
# exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
|
|
1805
1819
|
# is also returned when
|
|
@@ -1832,53 +1846,59 @@ module Google
|
|
|
1832
1846
|
#
|
|
1833
1847
|
# The largest that `max_tasks` can be is 1000.
|
|
1834
1848
|
#
|
|
1835
|
-
# The maximum total size of a
|
|
1836
|
-
# 32 MB. If the
|
|
1837
|
-
#
|
|
1849
|
+
# The maximum total size of a [lease tasks
|
|
1850
|
+
# response][google.cloud.tasks.v2beta2.LeaseTasksResponse] is 32 MB. If the
|
|
1851
|
+
# sum of all task sizes requested reaches this limit, fewer tasks than
|
|
1852
|
+
# requested are returned.
|
|
1838
1853
|
# @param lease_duration [::Google::Protobuf::Duration, ::Hash]
|
|
1839
1854
|
# Required. The duration of the lease.
|
|
1840
1855
|
#
|
|
1841
|
-
# Each task returned in the
|
|
1842
|
-
#
|
|
1843
|
-
#
|
|
1844
|
-
#
|
|
1845
|
-
#
|
|
1846
|
-
#
|
|
1856
|
+
# Each task returned in the
|
|
1857
|
+
# {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will have its
|
|
1858
|
+
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} set to the
|
|
1859
|
+
# current time plus the `lease_duration`. The task is leased until its
|
|
1860
|
+
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}; thus, the
|
|
1861
|
+
# task will not be returned to another
|
|
1862
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call before
|
|
1863
|
+
# its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
|
|
1847
1864
|
#
|
|
1848
1865
|
#
|
|
1849
1866
|
# After the worker has successfully finished the work associated
|
|
1850
1867
|
# with the task, the worker must call via
|
|
1851
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask}
|
|
1852
|
-
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
|
|
1853
|
-
# returned to a later
|
|
1854
|
-
#
|
|
1868
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask}
|
|
1869
|
+
# before the {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
|
|
1870
|
+
# Otherwise the task will be returned to a later
|
|
1871
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call so that
|
|
1872
|
+
# another worker can retry it.
|
|
1855
1873
|
#
|
|
1856
1874
|
# The maximum lease duration is 1 week.
|
|
1857
1875
|
# `lease_duration` will be truncated to the nearest second.
|
|
1858
1876
|
# @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
|
|
1859
|
-
# The response_view specifies which subset of the
|
|
1860
|
-
# returned.
|
|
1861
|
-
#
|
|
1862
|
-
# By default response_view is
|
|
1863
|
-
#
|
|
1864
|
-
#
|
|
1865
|
-
#
|
|
1866
|
-
# contains.
|
|
1867
|
-
#
|
|
1868
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
1869
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
1870
|
-
# permission on the
|
|
1877
|
+
# The response_view specifies which subset of the
|
|
1878
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
1879
|
+
#
|
|
1880
|
+
# By default response_view is
|
|
1881
|
+
# {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
1882
|
+
# retrieved by default because some data, such as payloads, might be
|
|
1883
|
+
# desirable to return only when needed because of its large size or because
|
|
1884
|
+
# of the sensitivity of data that it contains.
|
|
1885
|
+
#
|
|
1886
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
1887
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
1888
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
1889
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
1871
1890
|
# @param filter [::String]
|
|
1872
1891
|
# `filter` can be used to specify a subset of tasks to lease.
|
|
1873
1892
|
#
|
|
1874
1893
|
# When `filter` is set to `tag=<my-tag>` then the
|
|
1875
|
-
# {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only
|
|
1876
|
-
# {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to
|
|
1877
|
-
# less than 500 characters.
|
|
1894
|
+
# {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only
|
|
1895
|
+
# tasks whose {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to
|
|
1896
|
+
# `<my-tag>`. `<my-tag>` must be less than 500 characters.
|
|
1878
1897
|
#
|
|
1879
1898
|
# When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
|
|
1880
1899
|
# the same tag as the task with the oldest
|
|
1881
|
-
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
|
|
1900
|
+
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
|
|
1901
|
+
# returned.
|
|
1882
1902
|
#
|
|
1883
1903
|
# Grammar Syntax:
|
|
1884
1904
|
#
|
|
@@ -1896,8 +1916,9 @@ module Google
|
|
|
1896
1916
|
# [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
|
|
1897
1917
|
# only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
|
|
1898
1918
|
# aren't UTF-8 encoded can't be used in the
|
|
1899
|
-
# {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the
|
|
1900
|
-
# {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed
|
|
1919
|
+
# {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the
|
|
1920
|
+
# task's {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed
|
|
1921
|
+
# as empty in Cloud Tasks.
|
|
1901
1922
|
#
|
|
1902
1923
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1903
1924
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse]
|
|
@@ -1967,12 +1988,13 @@ module Google
|
|
|
1967
1988
|
# Acknowledges a pull task.
|
|
1968
1989
|
#
|
|
1969
1990
|
# The worker, that is, the entity that
|
|
1970
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks leased} this task must
|
|
1971
|
-
# to indicate that the work associated with the task has
|
|
1991
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks leased} this task must
|
|
1992
|
+
# call this method to indicate that the work associated with the task has
|
|
1993
|
+
# finished.
|
|
1972
1994
|
#
|
|
1973
1995
|
# The worker must acknowledge a task within the
|
|
1974
|
-
# {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#lease_duration lease_duration}
|
|
1975
|
-
# will expire and the task will become available to be leased
|
|
1996
|
+
# {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#lease_duration lease_duration}
|
|
1997
|
+
# or the lease will expire and the task will become available to be leased
|
|
1976
1998
|
# again. After the task is acknowledged, it will not be returned
|
|
1977
1999
|
# by a later {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks},
|
|
1978
2000
|
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#get_task GetTask}, or
|
|
@@ -2000,8 +2022,8 @@ module Google
|
|
|
2000
2022
|
# Required. The task's current schedule time, available in the
|
|
2001
2023
|
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
|
|
2002
2024
|
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
|
|
2003
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response.
|
|
2004
|
-
# to ensure that your worker currently holds the lease.
|
|
2025
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response.
|
|
2026
|
+
# This restriction is to ensure that your worker currently holds the lease.
|
|
2005
2027
|
#
|
|
2006
2028
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2007
2029
|
# @yieldparam response [::Google::Protobuf::Empty]
|
|
@@ -2072,7 +2094,8 @@ module Google
|
|
|
2072
2094
|
#
|
|
2073
2095
|
# The worker can use this method to extend the lease by a new
|
|
2074
2096
|
# duration, starting from now. The new task lease will be
|
|
2075
|
-
# returned in the task's
|
|
2097
|
+
# returned in the task's
|
|
2098
|
+
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
|
|
2076
2099
|
#
|
|
2077
2100
|
# @overload renew_lease(request, options = nil)
|
|
2078
2101
|
# Pass arguments to `renew_lease` via a request object, either of type
|
|
@@ -2096,8 +2119,8 @@ module Google
|
|
|
2096
2119
|
# Required. The task's current schedule time, available in the
|
|
2097
2120
|
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
|
|
2098
2121
|
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
|
|
2099
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response.
|
|
2100
|
-
# to ensure that your worker currently holds the lease.
|
|
2122
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response.
|
|
2123
|
+
# This restriction is to ensure that your worker currently holds the lease.
|
|
2101
2124
|
# @param lease_duration [::Google::Protobuf::Duration, ::Hash]
|
|
2102
2125
|
# Required. The desired new lease duration, starting from now.
|
|
2103
2126
|
#
|
|
@@ -2105,18 +2128,19 @@ module Google
|
|
|
2105
2128
|
# The maximum lease duration is 1 week.
|
|
2106
2129
|
# `lease_duration` will be truncated to the nearest second.
|
|
2107
2130
|
# @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
|
|
2108
|
-
# The response_view specifies which subset of the
|
|
2109
|
-
# returned.
|
|
2131
|
+
# The response_view specifies which subset of the
|
|
2132
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
2110
2133
|
#
|
|
2111
|
-
# By default response_view is
|
|
2112
|
-
#
|
|
2113
|
-
#
|
|
2114
|
-
#
|
|
2115
|
-
# contains.
|
|
2134
|
+
# By default response_view is
|
|
2135
|
+
# {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
2136
|
+
# retrieved by default because some data, such as payloads, might be
|
|
2137
|
+
# desirable to return only when needed because of its large size or because
|
|
2138
|
+
# of the sensitivity of data that it contains.
|
|
2116
2139
|
#
|
|
2117
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
2118
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
2119
|
-
# permission on the
|
|
2140
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
2141
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
2142
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
2143
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
2120
2144
|
#
|
|
2121
2145
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2122
2146
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
|
|
@@ -2186,9 +2210,9 @@ module Google
|
|
|
2186
2210
|
# Cancel a pull task's lease.
|
|
2187
2211
|
#
|
|
2188
2212
|
# The worker can use this method to cancel a task's lease by
|
|
2189
|
-
# setting its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}
|
|
2190
|
-
# make the task available to be leased to the next caller
|
|
2191
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks}.
|
|
2213
|
+
# setting its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}
|
|
2214
|
+
# to now. This will make the task available to be leased to the next caller
|
|
2215
|
+
# of {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks}.
|
|
2192
2216
|
#
|
|
2193
2217
|
# @overload cancel_lease(request, options = nil)
|
|
2194
2218
|
# Pass arguments to `cancel_lease` via a request object, either of type
|
|
@@ -2212,21 +2236,22 @@ module Google
|
|
|
2212
2236
|
# Required. The task's current schedule time, available in the
|
|
2213
2237
|
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
|
|
2214
2238
|
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
|
|
2215
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response.
|
|
2216
|
-
# to ensure that your worker currently holds the lease.
|
|
2239
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response.
|
|
2240
|
+
# This restriction is to ensure that your worker currently holds the lease.
|
|
2217
2241
|
# @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
|
|
2218
|
-
# The response_view specifies which subset of the
|
|
2219
|
-
# returned.
|
|
2242
|
+
# The response_view specifies which subset of the
|
|
2243
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
2220
2244
|
#
|
|
2221
|
-
# By default response_view is
|
|
2222
|
-
#
|
|
2223
|
-
#
|
|
2224
|
-
#
|
|
2225
|
-
# contains.
|
|
2245
|
+
# By default response_view is
|
|
2246
|
+
# {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
2247
|
+
# retrieved by default because some data, such as payloads, might be
|
|
2248
|
+
# desirable to return only when needed because of its large size or because
|
|
2249
|
+
# of the sensitivity of data that it contains.
|
|
2226
2250
|
#
|
|
2227
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
2228
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
2229
|
-
# permission on the
|
|
2251
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
2252
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
2253
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
2254
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
2230
2255
|
#
|
|
2231
2256
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2232
2257
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
|
|
@@ -2296,30 +2321,33 @@ module Google
|
|
|
2296
2321
|
# Forces a task to run now.
|
|
2297
2322
|
#
|
|
2298
2323
|
# When this method is called, Cloud Tasks will dispatch the task, even if
|
|
2299
|
-
# the task is already running, the queue has reached its
|
|
2300
|
-
#
|
|
2324
|
+
# the task is already running, the queue has reached its
|
|
2325
|
+
# {::Google::Cloud::Tasks::V2beta2::RateLimits RateLimits} or is
|
|
2326
|
+
# {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
|
|
2301
2327
|
#
|
|
2302
2328
|
# This command is meant to be used for manual debugging. For
|
|
2303
|
-
# example, {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} can be
|
|
2304
|
-
# task after a fix has been made or to manually force
|
|
2305
|
-
# dispatched now.
|
|
2329
|
+
# example, {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} can be
|
|
2330
|
+
# used to retry a failed task after a fix has been made or to manually force
|
|
2331
|
+
# a task to be dispatched now.
|
|
2306
2332
|
#
|
|
2307
2333
|
# The dispatched task is returned. That is, the task that is returned
|
|
2308
|
-
# contains the {::Google::Cloud::Tasks::V2beta2::Task#status status} after the
|
|
2309
|
-
# before the task is received by its target.
|
|
2334
|
+
# contains the {::Google::Cloud::Tasks::V2beta2::Task#status status} after the
|
|
2335
|
+
# task is dispatched but before the task is received by its target.
|
|
2310
2336
|
#
|
|
2311
2337
|
# If Cloud Tasks receives a successful response from the task's
|
|
2312
2338
|
# target, then the task will be deleted; otherwise the task's
|
|
2313
|
-
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
|
|
2314
|
-
#
|
|
2315
|
-
#
|
|
2339
|
+
# {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
|
|
2340
|
+
# reset to the time that
|
|
2341
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} was called plus
|
|
2342
|
+
# the retry delay specified in the queue's
|
|
2343
|
+
# {::Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig}.
|
|
2316
2344
|
#
|
|
2317
2345
|
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} returns
|
|
2318
2346
|
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
|
|
2319
2347
|
# task that has already succeeded or permanently failed.
|
|
2320
2348
|
#
|
|
2321
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} cannot be called
|
|
2322
|
-
# {::Google::Cloud::Tasks::V2beta2::PullMessage pull task}.
|
|
2349
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} cannot be called
|
|
2350
|
+
# on a {::Google::Cloud::Tasks::V2beta2::PullMessage pull task}.
|
|
2323
2351
|
#
|
|
2324
2352
|
# @overload run_task(request, options = nil)
|
|
2325
2353
|
# Pass arguments to `run_task` via a request object, either of type
|
|
@@ -2340,18 +2368,19 @@ module Google
|
|
|
2340
2368
|
# Required. The task name. For example:
|
|
2341
2369
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
|
2342
2370
|
# @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
|
|
2343
|
-
# The response_view specifies which subset of the
|
|
2344
|
-
# returned.
|
|
2371
|
+
# The response_view specifies which subset of the
|
|
2372
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
|
|
2345
2373
|
#
|
|
2346
|
-
# By default response_view is
|
|
2347
|
-
#
|
|
2348
|
-
#
|
|
2349
|
-
#
|
|
2350
|
-
# contains.
|
|
2374
|
+
# By default response_view is
|
|
2375
|
+
# {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all information is
|
|
2376
|
+
# retrieved by default because some data, such as payloads, might be
|
|
2377
|
+
# desirable to return only when needed because of its large size or because
|
|
2378
|
+
# of the sensitivity of data that it contains.
|
|
2351
2379
|
#
|
|
2352
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
2353
|
-
# `cloudtasks.tasks.fullView` [Google
|
|
2354
|
-
# permission on the
|
|
2380
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}
|
|
2381
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
|
2382
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
|
2383
|
+
# {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
|
|
2355
2384
|
#
|
|
2356
2385
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2357
2386
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
|
|
@@ -2455,9 +2484,9 @@ module Google
|
|
|
2455
2484
|
# * (`String`) The path to a service account key file in JSON format
|
|
2456
2485
|
# * (`Hash`) A service account key as a Hash
|
|
2457
2486
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
2458
|
-
# (see the [googleauth docs](https://
|
|
2487
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
2459
2488
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
2460
|
-
# (see the [signet docs](https://
|
|
2489
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
|
2461
2490
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
|
2462
2491
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
2463
2492
|
# * (`nil`) indicating no credentials
|