Skip to content
This repository was archived by the owner on Feb 1, 2024. It is now read-only.

Commit 85141f8

Browse files
docs: Fix formatting of request arg in docstring (#342)
* docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: googleapis/googleapis@8a085ae Source-Link: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent c8faa0c commit 85141f8

File tree

9 files changed

+50
-143
lines changed

9 files changed

+50
-143
lines changed

google/cloud/tasks_v2/services/cloud_tasks/async_client.py

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1241,8 +1241,7 @@ async def sample_get_iam_policy():
12411241
12421242
Args:
12431243
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
1244-
The request object. Request message for `GetIamPolicy`
1245-
method.
1244+
The request object. Request message for ``GetIamPolicy`` method.
12461245
resource (:class:`str`):
12471246
REQUIRED: The resource for which the
12481247
policy is being requested. See the
@@ -1429,8 +1428,7 @@ async def sample_set_iam_policy():
14291428
14301429
Args:
14311430
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
1432-
The request object. Request message for `SetIamPolicy`
1433-
method.
1431+
The request object. Request message for ``SetIamPolicy`` method.
14341432
resource (:class:`str`):
14351433
REQUIRED: The resource for which the
14361434
policy is being specified. See the
@@ -1605,8 +1603,7 @@ async def sample_test_iam_permissions():
16051603
16061604
Args:
16071605
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
1608-
The request object. Request message for
1609-
`TestIamPermissions` method.
1606+
The request object. Request message for ``TestIamPermissions`` method.
16101607
resource (:class:`str`):
16111608
REQUIRED: The resource for which the
16121609
policy detail is being requested. See
@@ -1739,8 +1736,7 @@ async def sample_list_tasks():
17391736
17401737
Args:
17411738
request (Optional[Union[google.cloud.tasks_v2.types.ListTasksRequest, dict]]):
1742-
The request object. Request message for listing tasks
1743-
using
1739+
The request object. Request message for listing tasks using
17441740
[ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
17451741
parent (:class:`str`):
17461742
Required. The queue name. For example:
@@ -1864,8 +1860,7 @@ async def sample_get_task():
18641860
18651861
Args:
18661862
request (Optional[Union[google.cloud.tasks_v2.types.GetTaskRequest, dict]]):
1867-
The request object. Request message for getting a task
1868-
using
1863+
The request object. Request message for getting a task using
18691864
[GetTask][google.cloud.tasks.v2.CloudTasks.GetTask].
18701865
name (:class:`str`):
18711866
Required. The task name. For example:
@@ -2131,8 +2126,7 @@ async def sample_delete_task():
21312126
21322127
Args:
21332128
request (Optional[Union[google.cloud.tasks_v2.types.DeleteTaskRequest, dict]]):
2134-
The request object. Request message for deleting a task
2135-
using
2129+
The request object. Request message for deleting a task using
21362130
[DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask].
21372131
name (:class:`str`):
21382132
Required. The task name. For example:
@@ -2261,8 +2255,7 @@ async def sample_run_task():
22612255
22622256
Args:
22632257
request (Optional[Union[google.cloud.tasks_v2.types.RunTaskRequest, dict]]):
2264-
The request object. Request message for forcing a task
2265-
to run now using
2258+
The request object. Request message for forcing a task to run now using
22662259
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
22672260
name (:class:`str`):
22682261
Required. The task name. For example:

google/cloud/tasks_v2/services/cloud_tasks/client.py

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1466,8 +1466,7 @@ def sample_get_iam_policy():
14661466
14671467
Args:
14681468
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
1469-
The request object. Request message for `GetIamPolicy`
1470-
method.
1469+
The request object. Request message for ``GetIamPolicy`` method.
14711470
resource (str):
14721471
REQUIRED: The resource for which the
14731472
policy is being requested. See the
@@ -1641,8 +1640,7 @@ def sample_set_iam_policy():
16411640
16421641
Args:
16431642
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
1644-
The request object. Request message for `SetIamPolicy`
1645-
method.
1643+
The request object. Request message for ``SetIamPolicy`` method.
16461644
resource (str):
16471645
REQUIRED: The resource for which the
16481646
policy is being specified. See the
@@ -1814,8 +1812,7 @@ def sample_test_iam_permissions():
18141812
18151813
Args:
18161814
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
1817-
The request object. Request message for
1818-
`TestIamPermissions` method.
1815+
The request object. Request message for ``TestIamPermissions`` method.
18191816
resource (str):
18201817
REQUIRED: The resource for which the
18211818
policy detail is being requested. See
@@ -1936,8 +1933,7 @@ def sample_list_tasks():
19361933
19371934
Args:
19381935
request (Union[google.cloud.tasks_v2.types.ListTasksRequest, dict]):
1939-
The request object. Request message for listing tasks
1940-
using
1936+
The request object. Request message for listing tasks using
19411937
[ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
19421938
parent (str):
19431939
Required. The queue name. For example:
@@ -2051,8 +2047,7 @@ def sample_get_task():
20512047
20522048
Args:
20532049
request (Union[google.cloud.tasks_v2.types.GetTaskRequest, dict]):
2054-
The request object. Request message for getting a task
2055-
using
2050+
The request object. Request message for getting a task using
20562051
[GetTask][google.cloud.tasks.v2.CloudTasks.GetTask].
20572052
name (str):
20582053
Required. The task name. For example:
@@ -2308,8 +2303,7 @@ def sample_delete_task():
23082303
23092304
Args:
23102305
request (Union[google.cloud.tasks_v2.types.DeleteTaskRequest, dict]):
2311-
The request object. Request message for deleting a task
2312-
using
2306+
The request object. Request message for deleting a task using
23132307
[DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask].
23142308
name (str):
23152309
Required. The task name. For example:
@@ -2428,8 +2422,7 @@ def sample_run_task():
24282422
24292423
Args:
24302424
request (Union[google.cloud.tasks_v2.types.RunTaskRequest, dict]):
2431-
The request object. Request message for forcing a task
2432-
to run now using
2425+
The request object. Request message for forcing a task to run now using
24332426
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
24342427
name (str):
24352428
Required. The task name. For example:

google/cloud/tasks_v2/services/cloud_tasks/transports/rest.py

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -629,7 +629,6 @@ def __call__(
629629
request (~.cloudtasks.CreateQueueRequest):
630630
The request object. Request message for
631631
[CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue].
632-
633632
retry (google.api_core.retry.Retry): Designation of what errors, if any,
634633
should be retried.
635634
timeout (float): The timeout for this request.
@@ -732,7 +731,6 @@ def __call__(
732731
request (~.cloudtasks.CreateTaskRequest):
733732
The request object. Request message for
734733
[CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
735-
736734
retry (google.api_core.retry.Retry): Designation of what errors, if any,
737735
should be retried.
738736
timeout (float): The timeout for this request.
@@ -829,7 +827,6 @@ def __call__(
829827
request (~.cloudtasks.DeleteQueueRequest):
830828
The request object. Request message for
831829
[DeleteQueue][google.cloud.tasks.v2.CloudTasks.DeleteQueue].
832-
833830
retry (google.api_core.retry.Retry): Designation of what errors, if any,
834831
should be retried.
835832
timeout (float): The timeout for this request.
@@ -905,7 +902,6 @@ def __call__(
905902
request (~.cloudtasks.DeleteTaskRequest):
906903
The request object. Request message for deleting a task using
907904
[DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask].
908-
909905
retry (google.api_core.retry.Retry): Designation of what errors, if any,
910906
should be retried.
911907
timeout (float): The timeout for this request.
@@ -1151,7 +1147,6 @@ def __call__(
11511147
request (~.cloudtasks.GetQueueRequest):
11521148
The request object. Request message for
11531149
[GetQueue][google.cloud.tasks.v2.CloudTasks.GetQueue].
1154-
11551150
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11561151
should be retried.
11571152
timeout (float): The timeout for this request.
@@ -1245,7 +1240,6 @@ def __call__(
12451240
request (~.cloudtasks.GetTaskRequest):
12461241
The request object. Request message for getting a task using
12471242
[GetTask][google.cloud.tasks.v2.CloudTasks.GetTask].
1248-
12491243
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12501244
should be retried.
12511245
timeout (float): The timeout for this request.
@@ -1333,7 +1327,6 @@ def __call__(
13331327
request (~.cloudtasks.ListQueuesRequest):
13341328
The request object. Request message for
13351329
[ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
1336-
13371330
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13381331
should be retried.
13391332
timeout (float): The timeout for this request.
@@ -1423,7 +1416,6 @@ def __call__(
14231416
request (~.cloudtasks.ListTasksRequest):
14241417
The request object. Request message for listing tasks using
14251418
[ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
1426-
14271419
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14281420
should be retried.
14291421
timeout (float): The timeout for this request.
@@ -1513,7 +1505,6 @@ def __call__(
15131505
request (~.cloudtasks.PauseQueueRequest):
15141506
The request object. Request message for
15151507
[PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue].
1516-
15171508
retry (google.api_core.retry.Retry): Designation of what errors, if any,
15181509
should be retried.
15191510
timeout (float): The timeout for this request.
@@ -1616,7 +1607,6 @@ def __call__(
16161607
request (~.cloudtasks.PurgeQueueRequest):
16171608
The request object. Request message for
16181609
[PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue].
1619-
16201610
retry (google.api_core.retry.Retry): Designation of what errors, if any,
16211611
should be retried.
16221612
timeout (float): The timeout for this request.
@@ -1719,7 +1709,6 @@ def __call__(
17191709
request (~.cloudtasks.ResumeQueueRequest):
17201710
The request object. Request message for
17211711
[ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue].
1722-
17231712
retry (google.api_core.retry.Retry): Designation of what errors, if any,
17241713
should be retried.
17251714
timeout (float): The timeout for this request.
@@ -1822,7 +1811,6 @@ def __call__(
18221811
request (~.cloudtasks.RunTaskRequest):
18231812
The request object. Request message for forcing a task to run now using
18241813
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
1825-
18261814
retry (google.api_core.retry.Retry): Designation of what errors, if any,
18271815
should be retried.
18281816
timeout (float): The timeout for this request.
@@ -2186,7 +2174,6 @@ def __call__(
21862174
request (~.cloudtasks.UpdateQueueRequest):
21872175
The request object. Request message for
21882176
[UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue].
2189-
21902177
retry (google.api_core.retry.Retry): Designation of what errors, if any,
21912178
should be retried.
21922179
timeout (float): The timeout for this request.

google/cloud/tasks_v2beta2/services/cloud_tasks/async_client.py

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1242,8 +1242,7 @@ async def sample_get_iam_policy():
12421242
12431243
Args:
12441244
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
1245-
The request object. Request message for `GetIamPolicy`
1246-
method.
1245+
The request object. Request message for ``GetIamPolicy`` method.
12471246
resource (:class:`str`):
12481247
REQUIRED: The resource for which the
12491248
policy is being requested. See the
@@ -1430,8 +1429,7 @@ async def sample_set_iam_policy():
14301429
14311430
Args:
14321431
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
1433-
The request object. Request message for `SetIamPolicy`
1434-
method.
1432+
The request object. Request message for ``SetIamPolicy`` method.
14351433
resource (:class:`str`):
14361434
REQUIRED: The resource for which the
14371435
policy is being specified. See the
@@ -1606,8 +1604,7 @@ async def sample_test_iam_permissions():
16061604
16071605
Args:
16081606
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
1609-
The request object. Request message for
1610-
`TestIamPermissions` method.
1607+
The request object. Request message for ``TestIamPermissions`` method.
16111608
resource (:class:`str`):
16121609
REQUIRED: The resource for which the
16131610
policy detail is being requested. See
@@ -1740,8 +1737,7 @@ async def sample_list_tasks():
17401737
17411738
Args:
17421739
request (Optional[Union[google.cloud.tasks_v2beta2.types.ListTasksRequest, dict]]):
1743-
The request object. Request message for listing tasks
1744-
using
1740+
The request object. Request message for listing tasks using
17451741
[ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
17461742
parent (:class:`str`):
17471743
Required. The queue name. For example:
@@ -1865,8 +1861,7 @@ async def sample_get_task():
18651861
18661862
Args:
18671863
request (Optional[Union[google.cloud.tasks_v2beta2.types.GetTaskRequest, dict]]):
1868-
The request object. Request message for getting a task
1869-
using
1864+
The request object. Request message for getting a task using
18701865
[GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].
18711866
name (:class:`str`):
18721867
Required. The task name. For example:
@@ -2136,8 +2131,7 @@ async def sample_delete_task():
21362131
21372132
Args:
21382133
request (Optional[Union[google.cloud.tasks_v2beta2.types.DeleteTaskRequest, dict]]):
2139-
The request object. Request message for deleting a task
2140-
using
2134+
The request object. Request message for deleting a task using
21412135
[DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].
21422136
name (:class:`str`):
21432137
Required. The task name. For example:
@@ -2264,8 +2258,7 @@ async def sample_lease_tasks():
22642258
22652259
Args:
22662260
request (Optional[Union[google.cloud.tasks_v2beta2.types.LeaseTasksRequest, dict]]):
2267-
The request object. Request message for leasing tasks
2268-
using
2261+
The request object. Request message for leasing tasks using
22692262
[LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
22702263
parent (:class:`str`):
22712264
Required. The queue name. For example:
@@ -2411,8 +2404,7 @@ async def sample_acknowledge_task():
24112404
24122405
Args:
24132406
request (Optional[Union[google.cloud.tasks_v2beta2.types.AcknowledgeTaskRequest, dict]]):
2414-
The request object. Request message for acknowledging a
2415-
task using
2407+
The request object. Request message for acknowledging a task using
24162408
[AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].
24172409
name (:class:`str`):
24182410
Required. The task name. For example:
@@ -2528,8 +2520,7 @@ async def sample_renew_lease():
25282520
25292521
Args:
25302522
request (Optional[Union[google.cloud.tasks_v2beta2.types.RenewLeaseRequest, dict]]):
2531-
The request object. Request message for renewing a lease
2532-
using
2523+
The request object. Request message for renewing a lease using
25332524
[RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].
25342525
name (:class:`str`):
25352526
Required. The task name. For example:
@@ -2665,8 +2656,7 @@ async def sample_cancel_lease():
26652656
26662657
Args:
26672658
request (Optional[Union[google.cloud.tasks_v2beta2.types.CancelLeaseRequest, dict]]):
2668-
The request object. Request message for canceling a
2669-
lease using
2659+
The request object. Request message for canceling a lease using
26702660
[CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].
26712661
name (:class:`str`):
26722662
Required. The task name. For example:
@@ -2814,8 +2804,7 @@ async def sample_run_task():
28142804
28152805
Args:
28162806
request (Optional[Union[google.cloud.tasks_v2beta2.types.RunTaskRequest, dict]]):
2817-
The request object. Request message for forcing a task
2818-
to run now using
2807+
The request object. Request message for forcing a task to run now using
28192808
[RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].
28202809
name (:class:`str`):
28212810
Required. The task name. For example:

0 commit comments

Comments
 (0)