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

Commit

Permalink
docs: Fix formatting of request arg in docstring (#342)
Browse files Browse the repository at this point in the history
* 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: googleapis/googleapis-gen@b2ab4b0
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>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Mar 23, 2023
1 parent c8faa0c commit 85141f8
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 143 deletions.
21 changes: 7 additions & 14 deletions google/cloud/tasks_v2/services/cloud_tasks/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1241,8 +1241,7 @@ async def sample_get_iam_policy():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -1429,8 +1428,7 @@ async def sample_set_iam_policy():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1605,8 +1603,7 @@ async def sample_test_iam_permissions():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down Expand Up @@ -1739,8 +1736,7 @@ async def sample_list_tasks():
Args:
request (Optional[Union[google.cloud.tasks_v2.types.ListTasksRequest, dict]]):
The request object. Request message for listing tasks
using
The request object. Request message for listing tasks using
[ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
parent (:class:`str`):
Required. The queue name. For example:
Expand Down Expand Up @@ -1864,8 +1860,7 @@ async def sample_get_task():
Args:
request (Optional[Union[google.cloud.tasks_v2.types.GetTaskRequest, dict]]):
The request object. Request message for getting a task
using
The request object. Request message for getting a task using
[GetTask][google.cloud.tasks.v2.CloudTasks.GetTask].
name (:class:`str`):
Required. The task name. For example:
Expand Down Expand Up @@ -2131,8 +2126,7 @@ async def sample_delete_task():
Args:
request (Optional[Union[google.cloud.tasks_v2.types.DeleteTaskRequest, dict]]):
The request object. Request message for deleting a task
using
The request object. Request message for deleting a task using
[DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask].
name (:class:`str`):
Required. The task name. For example:
Expand Down Expand Up @@ -2261,8 +2255,7 @@ async def sample_run_task():
Args:
request (Optional[Union[google.cloud.tasks_v2.types.RunTaskRequest, dict]]):
The request object. Request message for forcing a task
to run now using
The request object. Request message for forcing a task to run now using
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
name (:class:`str`):
Required. The task name. For example:
Expand Down
21 changes: 7 additions & 14 deletions google/cloud/tasks_v2/services/cloud_tasks/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1466,8 +1466,7 @@ def sample_get_iam_policy():
Args:
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -1641,8 +1640,7 @@ def sample_set_iam_policy():
Args:
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1814,8 +1812,7 @@ def sample_test_iam_permissions():
Args:
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down Expand Up @@ -1936,8 +1933,7 @@ def sample_list_tasks():
Args:
request (Union[google.cloud.tasks_v2.types.ListTasksRequest, dict]):
The request object. Request message for listing tasks
using
The request object. Request message for listing tasks using
[ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
parent (str):
Required. The queue name. For example:
Expand Down Expand Up @@ -2051,8 +2047,7 @@ def sample_get_task():
Args:
request (Union[google.cloud.tasks_v2.types.GetTaskRequest, dict]):
The request object. Request message for getting a task
using
The request object. Request message for getting a task using
[GetTask][google.cloud.tasks.v2.CloudTasks.GetTask].
name (str):
Required. The task name. For example:
Expand Down Expand Up @@ -2308,8 +2303,7 @@ def sample_delete_task():
Args:
request (Union[google.cloud.tasks_v2.types.DeleteTaskRequest, dict]):
The request object. Request message for deleting a task
using
The request object. Request message for deleting a task using
[DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask].
name (str):
Required. The task name. For example:
Expand Down Expand Up @@ -2428,8 +2422,7 @@ def sample_run_task():
Args:
request (Union[google.cloud.tasks_v2.types.RunTaskRequest, dict]):
The request object. Request message for forcing a task
to run now using
The request object. Request message for forcing a task to run now using
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
name (str):
Required. The task name. For example:
Expand Down
13 changes: 0 additions & 13 deletions google/cloud/tasks_v2/services/cloud_tasks/transports/rest.py
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,6 @@ def __call__(
request (~.cloudtasks.CreateQueueRequest):
The request object. Request message for
[CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -732,7 +731,6 @@ def __call__(
request (~.cloudtasks.CreateTaskRequest):
The request object. Request message for
[CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -829,7 +827,6 @@ def __call__(
request (~.cloudtasks.DeleteQueueRequest):
The request object. Request message for
[DeleteQueue][google.cloud.tasks.v2.CloudTasks.DeleteQueue].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -905,7 +902,6 @@ def __call__(
request (~.cloudtasks.DeleteTaskRequest):
The request object. Request message for deleting a task using
[DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1151,7 +1147,6 @@ def __call__(
request (~.cloudtasks.GetQueueRequest):
The request object. Request message for
[GetQueue][google.cloud.tasks.v2.CloudTasks.GetQueue].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1245,7 +1240,6 @@ def __call__(
request (~.cloudtasks.GetTaskRequest):
The request object. Request message for getting a task using
[GetTask][google.cloud.tasks.v2.CloudTasks.GetTask].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1333,7 +1327,6 @@ def __call__(
request (~.cloudtasks.ListQueuesRequest):
The request object. Request message for
[ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1423,7 +1416,6 @@ def __call__(
request (~.cloudtasks.ListTasksRequest):
The request object. Request message for listing tasks using
[ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1513,7 +1505,6 @@ def __call__(
request (~.cloudtasks.PauseQueueRequest):
The request object. Request message for
[PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1616,7 +1607,6 @@ def __call__(
request (~.cloudtasks.PurgeQueueRequest):
The request object. Request message for
[PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1719,7 +1709,6 @@ def __call__(
request (~.cloudtasks.ResumeQueueRequest):
The request object. Request message for
[ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1822,7 +1811,6 @@ def __call__(
request (~.cloudtasks.RunTaskRequest):
The request object. Request message for forcing a task to run now using
[RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2186,7 +2174,6 @@ def __call__(
request (~.cloudtasks.UpdateQueueRequest):
The request object. Request message for
[UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue].
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
33 changes: 11 additions & 22 deletions google/cloud/tasks_v2beta2/services/cloud_tasks/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1242,8 +1242,7 @@ async def sample_get_iam_policy():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -1430,8 +1429,7 @@ async def sample_set_iam_policy():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1606,8 +1604,7 @@ async def sample_test_iam_permissions():
Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down Expand Up @@ -1740,8 +1737,7 @@ async def sample_list_tasks():
Args:
request (Optional[Union[google.cloud.tasks_v2beta2.types.ListTasksRequest, dict]]):
The request object. Request message for listing tasks
using
The request object. Request message for listing tasks using
[ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
parent (:class:`str`):
Required. The queue name. For example:
Expand Down Expand Up @@ -1865,8 +1861,7 @@ async def sample_get_task():
Args:
request (Optional[Union[google.cloud.tasks_v2beta2.types.GetTaskRequest, dict]]):
The request object. Request message for getting a task
using
The request object. Request message for getting a task using
[GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].
name (:class:`str`):
Required. The task name. For example:
Expand Down Expand Up @@ -2136,8 +2131,7 @@ async def sample_delete_task():
Args:
request (Optional[Union[google.cloud.tasks_v2beta2.types.DeleteTaskRequest, dict]]):
The request object. Request message for deleting a task
using
The request object. Request message for deleting a task using
[DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].
name (:class:`str`):
Required. The task name. For example:
Expand Down Expand Up @@ -2264,8 +2258,7 @@ async def sample_lease_tasks():
Args:
request (Optional[Union[google.cloud.tasks_v2beta2.types.LeaseTasksRequest, dict]]):
The request object. Request message for leasing tasks
using
The request object. Request message for leasing tasks using
[LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
parent (:class:`str`):
Required. The queue name. For example:
Expand Down Expand Up @@ -2411,8 +2404,7 @@ async def sample_acknowledge_task():
Args:
request (Optional[Union[google.cloud.tasks_v2beta2.types.AcknowledgeTaskRequest, dict]]):
The request object. Request message for acknowledging a
task using
The request object. Request message for acknowledging a task using
[AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].
name (:class:`str`):
Required. The task name. For example:
Expand Down Expand Up @@ -2528,8 +2520,7 @@ async def sample_renew_lease():
Args:
request (Optional[Union[google.cloud.tasks_v2beta2.types.RenewLeaseRequest, dict]]):
The request object. Request message for renewing a lease
using
The request object. Request message for renewing a lease using
[RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].
name (:class:`str`):
Required. The task name. For example:
Expand Down Expand Up @@ -2665,8 +2656,7 @@ async def sample_cancel_lease():
Args:
request (Optional[Union[google.cloud.tasks_v2beta2.types.CancelLeaseRequest, dict]]):
The request object. Request message for canceling a
lease using
The request object. Request message for canceling a lease using
[CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].
name (:class:`str`):
Required. The task name. For example:
Expand Down Expand Up @@ -2814,8 +2804,7 @@ async def sample_run_task():
Args:
request (Optional[Union[google.cloud.tasks_v2beta2.types.RunTaskRequest, dict]]):
The request object. Request message for forcing a task
to run now using
The request object. Request message for forcing a task to run now using
[RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].
name (:class:`str`):
Required. The task name. For example:
Expand Down

0 comments on commit 85141f8

Please sign in to comment.