google-cloud-tasks-v2beta2 0.7.0 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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 {::Google::Cloud::Tasks::V2beta2::Queue Queue}
237
- # field can be used as a filter and several operators as supported.
238
- # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
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} in the
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} returned
261
- # from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}
262
- # method. It is an error to switch the value of the
263
- # {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while iterating through pages.
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 returns.
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
  #
@@ -287,13 +288,11 @@ module Google
287
288
  # # Call the list_queues method.
288
289
  # result = client.list_queues request
289
290
  #
290
- # # The returned object is of type Gapic::PagedEnumerable. You can
291
- # # iterate over all elements by calling #each, and the enumerable
292
- # # will lazily make API calls to fetch subsequent pages. Other
293
- # # methods are also available for managing paging directly.
294
- # result.each do |response|
291
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
292
+ # # over elements, and API calls will be issued to fetch pages as needed.
293
+ # result.each do |item|
295
294
  # # Each element is of type ::Google::Cloud::Tasks::V2beta2::Queue.
296
- # p response
295
+ # p item
297
296
  # end
298
297
  #
299
298
  def list_queues request, options = nil
@@ -360,8 +359,8 @@ module Google
360
359
  # Required. The resource name of the queue. For example:
361
360
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
362
361
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
363
- # Optional. Read mask is used for a more granular control over what the API returns.
364
- # 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
365
364
  # [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
366
365
  # specified in the mask.
367
366
  #
@@ -433,8 +432,8 @@ module Google
433
432
  # Creates a queue.
434
433
  #
435
434
  # Queues created with this method allow tasks to live for a maximum of 31
436
- # days. After a task is 31 days old, the task will be deleted regardless of whether
437
- # 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.
438
437
  #
439
438
  # WARNING: Using this method may have unintended side effects if you are
440
439
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
@@ -468,7 +467,8 @@ module Google
468
467
  # @param queue [::Google::Cloud::Tasks::V2beta2::Queue, ::Hash]
469
468
  # Required. The queue to create.
470
469
  #
471
- # [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as an existing queue.
470
+ # [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as
471
+ # an existing queue.
472
472
  #
473
473
  # @yield [response, operation] Access the result along with the RPC operation
474
474
  # @yieldparam response [::Google::Cloud::Tasks::V2beta2::Queue]
@@ -541,8 +541,8 @@ module Google
541
541
  # the queue if it does exist.
542
542
  #
543
543
  # Queues created with this method allow tasks to live for a maximum of 31
544
- # days. After a task is 31 days old, the task will be deleted regardless of whether
545
- # 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.
546
546
  #
547
547
  # WARNING: Using this method may have unintended side effects if you are
548
548
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
@@ -569,11 +569,13 @@ module Google
569
569
  # @param queue [::Google::Cloud::Tasks::V2beta2::Queue, ::Hash]
570
570
  # Required. The queue to create or update.
571
571
  #
572
- # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} must be specified.
572
+ # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} must be
573
+ # specified.
573
574
  #
574
575
  # Output only fields cannot be modified using UpdateQueue.
575
576
  # Any value specified for an output only field will be ignored.
576
- # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be changed.
577
+ # The queue's {::Google::Cloud::Tasks::V2beta2::Queue#name name} cannot be
578
+ # changed.
577
579
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
578
580
  # A mask used to specify which fields of the queue are being updated.
579
581
  #
@@ -837,9 +839,10 @@ module Google
837
839
  #
838
840
  # If a queue is paused then the system will stop dispatching tasks
839
841
  # until the queue is resumed via
840
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#resume_queue ResumeQueue}. Tasks can still be added
841
- # when the queue is paused. A queue is paused if its
842
- # {::Google::Cloud::Tasks::V2beta2::Queue#state state} is {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
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}.
843
846
  #
844
847
  # @overload pause_queue(request, options = nil)
845
848
  # Pass arguments to `pause_queue` via a request object, either of type
@@ -929,9 +932,11 @@ module Google
929
932
  #
930
933
  # This method resumes a queue after it has been
931
934
  # {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED} or
932
- # {::Google::Cloud::Tasks::V2beta2::Queue::State::DISABLED DISABLED}. The state of a queue is stored
933
- # in the queue's {::Google::Cloud::Tasks::V2beta2::Queue#state state}; after calling this method it
934
- # will be set to {::Google::Cloud::Tasks::V2beta2::Queue::State::RUNNING RUNNING}.
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}.
935
940
  #
936
941
  # WARNING: Resuming many high-QPS queues at the same time can
937
942
  # lead to target overloading. If you are resuming high-QPS
@@ -1023,9 +1028,9 @@ module Google
1023
1028
  end
1024
1029
 
1025
1030
  ##
1026
- # Gets the access control policy for a {::Google::Cloud::Tasks::V2beta2::Queue Queue}.
1027
- # Returns an empty policy if the resource exists and does not have a policy
1028
- # 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.
1029
1034
  #
1030
1035
  # Authorization requires the following
1031
1036
  # [Google IAM](https://cloud.google.com/iam) permission on the specified
@@ -1120,8 +1125,8 @@ module Google
1120
1125
  end
1121
1126
 
1122
1127
  ##
1123
- # Sets the access control policy for a {::Google::Cloud::Tasks::V2beta2::Queue Queue}. Replaces any existing
1124
- # policy.
1128
+ # Sets the access control policy for a
1129
+ # {::Google::Cloud::Tasks::V2beta2::Queue Queue}. Replaces any existing policy.
1125
1130
  #
1126
1131
  # Note: The Cloud Console does not check queue-level IAM permissions yet.
1127
1132
  # Project-level permissions are required to use the Cloud Console.
@@ -1227,9 +1232,10 @@ module Google
1227
1232
  end
1228
1233
 
1229
1234
  ##
1230
- # Returns permissions that a caller has on a {::Google::Cloud::Tasks::V2beta2::Queue Queue}.
1231
- # If the resource does not exist, this will return an empty set of
1232
- # permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
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.
1233
1239
  #
1234
1240
  # Note: This operation is designed to be used for building permission-aware
1235
1241
  # UIs and command-line tools, not for authorization checking. This operation
@@ -1326,10 +1332,10 @@ module Google
1326
1332
  ##
1327
1333
  # Lists the tasks in a queue.
1328
1334
  #
1329
- # By default, only the {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC} view is retrieved
1330
- # due to performance considerations;
1331
- # {::Google::Cloud::Tasks::V2beta2::ListTasksRequest#response_view response_view} controls the
1332
- # 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.
1333
1339
  #
1334
1340
  # The tasks may be returned in any order. The ordering may change at any
1335
1341
  # time.
@@ -1353,24 +1359,25 @@ module Google
1353
1359
  # Required. The queue name. For example:
1354
1360
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
1355
1361
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1356
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1357
- # returned.
1358
- #
1359
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1360
- # information is retrieved by default because some data, such as
1361
- # payloads, might be desirable to return only when needed because
1362
- # of its large size or because of the sensitivity of data that it
1363
- # contains.
1364
- #
1365
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1366
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1367
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
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.
1368
1375
  # @param page_size [::Integer]
1369
1376
  # Maximum page size.
1370
1377
  #
1371
1378
  # Fewer tasks than requested might be returned, even if more tasks exist; use
1372
- # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token} in the response to
1373
- # 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.
1374
1381
  #
1375
1382
  # The maximum page size is 1000. If unspecified, the page size will be the
1376
1383
  # maximum.
@@ -1379,9 +1386,9 @@ module Google
1379
1386
  #
1380
1387
  # To request the first page results, page_token must be empty. To
1381
1388
  # request the next page of results, page_token must be the value of
1382
- # {::Google::Cloud::Tasks::V2beta2::ListTasksResponse#next_page_token next_page_token} returned
1383
- # from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_tasks ListTasks}
1384
- # 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.
1385
1392
  #
1386
1393
  # The page token is valid for only 2 hours.
1387
1394
  #
@@ -1405,13 +1412,11 @@ module Google
1405
1412
  # # Call the list_tasks method.
1406
1413
  # result = client.list_tasks request
1407
1414
  #
1408
- # # The returned object is of type Gapic::PagedEnumerable. You can
1409
- # # iterate over all elements by calling #each, and the enumerable
1410
- # # will lazily make API calls to fetch subsequent pages. Other
1411
- # # methods are also available for managing paging directly.
1412
- # result.each do |response|
1415
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1416
+ # # over elements, and API calls will be issued to fetch pages as needed.
1417
+ # result.each do |item|
1413
1418
  # # Each element is of type ::Google::Cloud::Tasks::V2beta2::Task.
1414
- # p response
1419
+ # p item
1415
1420
  # end
1416
1421
  #
1417
1422
  def list_tasks request, options = nil
@@ -1478,18 +1483,19 @@ module Google
1478
1483
  # Required. The task name. For example:
1479
1484
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
1480
1485
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1481
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1482
- # returned.
1486
+ # The response_view specifies which subset of the
1487
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1483
1488
  #
1484
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1485
- # information is retrieved by default because some data, such as
1486
- # payloads, might be desirable to return only when needed because
1487
- # of its large size or because of the sensitivity of data that it
1488
- # 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.
1489
1494
  #
1490
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1491
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1492
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
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.
1493
1499
  #
1494
1500
  # @yield [response, operation] Access the result along with the RPC operation
1495
1501
  # @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
@@ -1560,9 +1566,11 @@ module Google
1560
1566
  #
1561
1567
  # Tasks cannot be updated after creation; there is no UpdateTask command.
1562
1568
  #
1563
- # * For {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues}, the maximum task size is
1569
+ # * For {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues},
1570
+ # the maximum task size is
1564
1571
  # 100KB.
1565
- # * For {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}, the maximum task size is 1MB.
1572
+ # * For {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}, the maximum
1573
+ # task size is 1MB.
1566
1574
  #
1567
1575
  # @overload create_task(request, options = nil)
1568
1576
  # Pass arguments to `create_task` via a request object, either of type
@@ -1589,13 +1597,13 @@ module Google
1589
1597
  #
1590
1598
  # Task names have the following format:
1591
1599
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
1592
- # The user can optionally specify a task {::Google::Cloud::Tasks::V2beta2::Task#name name}. If a
1593
- # name is not specified then the system will generate a random
1594
- # unique task id, which will be set in the task returned in the
1595
- # {::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}.
1596
1604
  #
1597
- # If {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} is not set or is in the
1598
- # 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.
1599
1607
  #
1600
1608
  # Task De-duplication:
1601
1609
  #
@@ -1610,27 +1618,28 @@ module Google
1610
1618
  # for ~9days after the original task was deleted or completed.
1611
1619
  #
1612
1620
  # Because there is an extra lookup cost to identify duplicate task
1613
- # names, these {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask} calls have significantly
1614
- # increased latency. Using hashed strings for the task id or for
1615
- # the prefix of the task id is recommended. Choosing task ids that
1616
- # 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
1617
1625
  # timestamp, causes an increase in latency and error rates in all
1618
1626
  # task commands. The infrastructure relies on an approximately
1619
1627
  # uniform distribution of task ids to store and serve tasks
1620
1628
  # efficiently.
1621
1629
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1622
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1623
- # returned.
1630
+ # The response_view specifies which subset of the
1631
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
1624
1632
  #
1625
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1626
- # information is retrieved by default because some data, such as
1627
- # payloads, might be desirable to return only when needed because
1628
- # of its large size or because of the sensitivity of data that it
1629
- # 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.
1630
1638
  #
1631
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1632
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1633
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
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.
1634
1643
  #
1635
1644
  # @yield [response, operation] Access the result along with the RPC operation
1636
1645
  # @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
@@ -1792,18 +1801,19 @@ module Google
1792
1801
  #
1793
1802
  # This method is invoked by the worker to obtain a lease. The
1794
1803
  # worker must acknowledge the task via
1795
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask} after they have
1796
- # performed the work associated with the task.
1797
- #
1798
- # The {::Google::Cloud::Tasks::V2beta2::PullMessage#payload payload} is intended to store data that
1799
- # the worker needs to perform the work associated with the task. To
1800
- # return the payloads in the {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response}, set
1801
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#response_view response_view} to
1802
- # {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL}.
1803
- #
1804
- # A maximum of 10 qps of {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks}
1805
- # requests are allowed per
1806
- # queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
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]
1807
1817
  # is returned when this limit is
1808
1818
  # exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
1809
1819
  # is also returned when
@@ -1836,53 +1846,59 @@ module Google
1836
1846
  #
1837
1847
  # The largest that `max_tasks` can be is 1000.
1838
1848
  #
1839
- # The maximum total size of a {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse lease tasks response} is
1840
- # 32 MB. If the sum of all task sizes requested reaches this limit,
1841
- # fewer tasks than requested are returned.
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.
1842
1853
  # @param lease_duration [::Google::Protobuf::Duration, ::Hash]
1843
1854
  # Required. The duration of the lease.
1844
1855
  #
1845
- # Each task returned in the {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will
1846
- # have its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} set to the current
1847
- # time plus the `lease_duration`. The task is leased until its
1848
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}; thus, the task will not be
1849
- # returned to another {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call
1850
- # before its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
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}.
1851
1864
  #
1852
1865
  #
1853
1866
  # After the worker has successfully finished the work associated
1854
1867
  # with the task, the worker must call via
1855
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#acknowledge_task AcknowledgeTask} before the
1856
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}. Otherwise the task will be
1857
- # returned to a later {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} call so
1858
- # that another worker can retry it.
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.
1859
1873
  #
1860
1874
  # The maximum lease duration is 1 week.
1861
1875
  # `lease_duration` will be truncated to the nearest second.
1862
1876
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
1863
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
1864
- # returned.
1865
- #
1866
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
1867
- # information is retrieved by default because some data, such as
1868
- # payloads, might be desirable to return only when needed because
1869
- # of its large size or because of the sensitivity of data that it
1870
- # contains.
1871
- #
1872
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
1873
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
1874
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
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.
1875
1890
  # @param filter [::String]
1876
1891
  # `filter` can be used to specify a subset of tasks to lease.
1877
1892
  #
1878
1893
  # When `filter` is set to `tag=<my-tag>` then the
1879
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only tasks whose
1880
- # {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to `<my-tag>`. `<my-tag>` must be
1881
- # 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.
1882
1897
  #
1883
1898
  # When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
1884
1899
  # the same tag as the task with the oldest
1885
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be returned.
1900
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be
1901
+ # returned.
1886
1902
  #
1887
1903
  # Grammar Syntax:
1888
1904
  #
@@ -1900,8 +1916,9 @@ module Google
1900
1916
  # [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
1901
1917
  # only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
1902
1918
  # aren't UTF-8 encoded can't be used in the
1903
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter} and the task's
1904
- # {::Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} will be displayed as empty in Cloud Tasks.
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.
1905
1922
  #
1906
1923
  # @yield [response, operation] Access the result along with the RPC operation
1907
1924
  # @yieldparam response [::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse]
@@ -1971,12 +1988,13 @@ module Google
1971
1988
  # Acknowledges a pull task.
1972
1989
  #
1973
1990
  # The worker, that is, the entity that
1974
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks leased} this task must call this method
1975
- # to indicate that the work associated with the task has finished.
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.
1976
1994
  #
1977
1995
  # The worker must acknowledge a task within the
1978
- # {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#lease_duration lease_duration} or the lease
1979
- # 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
1980
1998
  # again. After the task is acknowledged, it will not be returned
1981
1999
  # by a later {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks},
1982
2000
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#get_task GetTask}, or
@@ -2004,8 +2022,8 @@ module Google
2004
2022
  # Required. The task's current schedule time, available in the
2005
2023
  # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
2006
2024
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
2007
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response. This restriction is
2008
- # 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.
2009
2027
  #
2010
2028
  # @yield [response, operation] Access the result along with the RPC operation
2011
2029
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -2076,7 +2094,8 @@ module Google
2076
2094
  #
2077
2095
  # The worker can use this method to extend the lease by a new
2078
2096
  # duration, starting from now. The new task lease will be
2079
- # returned in the task's {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
2097
+ # returned in the task's
2098
+ # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}.
2080
2099
  #
2081
2100
  # @overload renew_lease(request, options = nil)
2082
2101
  # Pass arguments to `renew_lease` via a request object, either of type
@@ -2100,8 +2119,8 @@ module Google
2100
2119
  # Required. The task's current schedule time, available in the
2101
2120
  # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
2102
2121
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
2103
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response. This restriction is
2104
- # 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.
2105
2124
  # @param lease_duration [::Google::Protobuf::Duration, ::Hash]
2106
2125
  # Required. The desired new lease duration, starting from now.
2107
2126
  #
@@ -2109,18 +2128,19 @@ module Google
2109
2128
  # The maximum lease duration is 1 week.
2110
2129
  # `lease_duration` will be truncated to the nearest second.
2111
2130
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
2112
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
2113
- # returned.
2131
+ # The response_view specifies which subset of the
2132
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
2114
2133
  #
2115
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
2116
- # information is retrieved by default because some data, such as
2117
- # payloads, might be desirable to return only when needed because
2118
- # of its large size or because of the sensitivity of data that it
2119
- # 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.
2120
2139
  #
2121
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
2122
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
2123
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
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.
2124
2144
  #
2125
2145
  # @yield [response, operation] Access the result along with the RPC operation
2126
2146
  # @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
@@ -2190,9 +2210,9 @@ module Google
2190
2210
  # Cancel a pull task's lease.
2191
2211
  #
2192
2212
  # The worker can use this method to cancel a task's lease by
2193
- # setting its {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} to now. This will
2194
- # make the task available to be leased to the next caller of
2195
- # {::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}.
2196
2216
  #
2197
2217
  # @overload cancel_lease(request, options = nil)
2198
2218
  # Pass arguments to `cancel_lease` via a request object, either of type
@@ -2216,21 +2236,22 @@ module Google
2216
2236
  # Required. The task's current schedule time, available in the
2217
2237
  # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
2218
2238
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} response or
2219
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#renew_lease RenewLease} response. This restriction is
2220
- # 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.
2221
2241
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
2222
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
2223
- # returned.
2242
+ # The response_view specifies which subset of the
2243
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
2224
2244
  #
2225
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
2226
- # information is retrieved by default because some data, such as
2227
- # payloads, might be desirable to return only when needed because
2228
- # of its large size or because of the sensitivity of data that it
2229
- # 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.
2230
2250
  #
2231
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
2232
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
2233
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
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.
2234
2255
  #
2235
2256
  # @yield [response, operation] Access the result along with the RPC operation
2236
2257
  # @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
@@ -2300,30 +2321,33 @@ module Google
2300
2321
  # Forces a task to run now.
2301
2322
  #
2302
2323
  # When this method is called, Cloud Tasks will dispatch the task, even if
2303
- # the task is already running, the queue has reached its {::Google::Cloud::Tasks::V2beta2::RateLimits RateLimits} or
2304
- # is {::Google::Cloud::Tasks::V2beta2::Queue::State::PAUSED PAUSED}.
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}.
2305
2327
  #
2306
2328
  # This command is meant to be used for manual debugging. For
2307
- # example, {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} can be used to retry a failed
2308
- # task after a fix has been made or to manually force a task to be
2309
- # 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.
2310
2332
  #
2311
2333
  # The dispatched task is returned. That is, the task that is returned
2312
- # contains the {::Google::Cloud::Tasks::V2beta2::Task#status status} after the task is dispatched but
2313
- # 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.
2314
2336
  #
2315
2337
  # If Cloud Tasks receives a successful response from the task's
2316
2338
  # target, then the task will be deleted; otherwise the task's
2317
- # {::Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be reset to the time that
2318
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} was called plus the retry delay specified
2319
- # in the queue's {::Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig}.
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}.
2320
2344
  #
2321
2345
  # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} returns
2322
2346
  # [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
2323
2347
  # task that has already succeeded or permanently failed.
2324
2348
  #
2325
- # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask} cannot be called on a
2326
- # {::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}.
2327
2351
  #
2328
2352
  # @overload run_task(request, options = nil)
2329
2353
  # Pass arguments to `run_task` via a request object, either of type
@@ -2344,18 +2368,19 @@ module Google
2344
2368
  # Required. The task name. For example:
2345
2369
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
2346
2370
  # @param response_view [::Google::Cloud::Tasks::V2beta2::Task::View]
2347
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2beta2::Task Task} will be
2348
- # returned.
2371
+ # The response_view specifies which subset of the
2372
+ # {::Google::Cloud::Tasks::V2beta2::Task Task} will be returned.
2349
2373
  #
2350
- # By default response_view is {::Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
2351
- # information is retrieved by default because some data, such as
2352
- # payloads, might be desirable to return only when needed because
2353
- # of its large size or because of the sensitivity of data that it
2354
- # 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.
2355
2379
  #
2356
- # Authorization for {::Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
2357
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
2358
- # permission on the {::Google::Cloud::Tasks::V2beta2::Task Task} resource.
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.
2359
2384
  #
2360
2385
  # @yield [response, operation] Access the result along with the RPC operation
2361
2386
  # @yieldparam response [::Google::Cloud::Tasks::V2beta2::Task]
@@ -2459,9 +2484,9 @@ module Google
2459
2484
  # * (`String`) The path to a service account key file in JSON format
2460
2485
  # * (`Hash`) A service account key as a Hash
2461
2486
  # * (`Google::Auth::Credentials`) A googleauth credentials object
2462
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
2487
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
2463
2488
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
2464
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
2489
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
2465
2490
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
2466
2491
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
2467
2492
  # * (`nil`) indicating no credentials