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

docs: Minor formatting #369

Merged
merged 2 commits into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions google/cloud/tasks_v2/services/cloud_tasks/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ async def list_queues(
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListQueuesAsyncPager:
r"""Lists queues.

Queues are returned in lexicographical order.

.. code-block:: python
Expand Down Expand Up @@ -860,8 +861,10 @@ async def purge_queue(
metadata: Sequence[Tuple[str, str]] = (),
) -> queue.Queue:
r"""Purges a queue by deleting all of its tasks.

All tasks created before this method is called are
permanently deleted.

Purge operations can take up to one minute to take
effect. Tasks might be dispatched before the purge takes
effect. A purge is irreversible.
Expand Down Expand Up @@ -1245,8 +1248,8 @@ async def sample_get_iam_policy():
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested.
See the operation documentation for the
policy is being requested. See the
operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1401,8 +1404,8 @@ async def sample_set_iam_policy():
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified.
See the operation documentation for the
policy is being specified. See the
operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1545,8 +1548,8 @@ async def sample_test_iam_permissions():
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested.
See the operation documentation for the
policy detail is being requested. See
the operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -2036,6 +2039,7 @@ async def delete_task(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes a task.

A task can be deleted if it is scheduled or dispatched.
A task cannot be deleted if it has executed successfully
or permanently failed.
Expand Down
16 changes: 10 additions & 6 deletions google/cloud/tasks_v2/services/cloud_tasks/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,7 @@ def list_queues(
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListQueuesPager:
r"""Lists queues.

Queues are returned in lexicographical order.

.. code-block:: python
Expand Down Expand Up @@ -1085,8 +1086,10 @@ def purge_queue(
metadata: Sequence[Tuple[str, str]] = (),
) -> queue.Queue:
r"""Purges a queue by deleting all of its tasks.

All tasks created before this method is called are
permanently deleted.

Purge operations can take up to one minute to take
effect. Tasks might be dispatched before the purge takes
effect. A purge is irreversible.
Expand Down Expand Up @@ -1470,8 +1473,8 @@ def sample_get_iam_policy():
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested.
See the operation documentation for the
policy is being requested. See the
operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1613,8 +1616,8 @@ def sample_set_iam_policy():
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified.
See the operation documentation for the
policy is being specified. See the
operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1754,8 +1757,8 @@ def sample_test_iam_permissions():
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested.
See the operation documentation for the
policy detail is being requested. See
the operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -2213,6 +2216,7 @@ def delete_task(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes a task.

A task can be deleted if it is scheduled or dispatched.
A task cannot be deleted if it has executed successfully
or permanently failed.
Expand Down
4 changes: 4 additions & 0 deletions google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@ def list_queues(
r"""Return a callable for the list queues method over gRPC.

Lists queues.

Queues are returned in lexicographical order.

Returns:
Expand Down Expand Up @@ -405,8 +406,10 @@ def purge_queue(self) -> Callable[[cloudtasks.PurgeQueueRequest], queue.Queue]:
r"""Return a callable for the purge queue method over gRPC.

Purges a queue by deleting all of its tasks.

All tasks created before this method is called are
permanently deleted.

Purge operations can take up to one minute to take
effect. Tasks might be dispatched before the purge takes
effect. A purge is irreversible.
Expand Down Expand Up @@ -700,6 +703,7 @@ def delete_task(self) -> Callable[[cloudtasks.DeleteTaskRequest], empty_pb2.Empt
r"""Return a callable for the delete task method over gRPC.

Deletes a task.

A task can be deleted if it is scheduled or dispatched.
A task cannot be deleted if it has executed successfully
or permanently failed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,7 @@ def list_queues(
r"""Return a callable for the list queues method over gRPC.

Lists queues.

Queues are returned in lexicographical order.

Returns:
Expand Down Expand Up @@ -414,8 +415,10 @@ def purge_queue(
r"""Return a callable for the purge queue method over gRPC.

Purges a queue by deleting all of its tasks.

All tasks created before this method is called are
permanently deleted.

Purge operations can take up to one minute to take
effect. Tasks might be dispatched before the purge takes
effect. A purge is irreversible.
Expand Down Expand Up @@ -719,6 +722,7 @@ def delete_task(
r"""Return a callable for the delete task method over gRPC.

Deletes a task.

A task can be deleted if it is scheduled or dispatched.
A task cannot be deleted if it has executed successfully
or permanently failed.
Expand Down
1 change: 1 addition & 0 deletions google/cloud/tasks_v2/types/queue.py
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@ class RateLimits(proto.Message):

class RetryConfig(proto.Message):
r"""Retry config.

These settings determine when a failed task attempt is retried.

Attributes:
Expand Down
1 change: 1 addition & 0 deletions google/cloud/tasks_v2/types/target.py
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,7 @@ class AppEngineHttpRequest(proto.Message):
app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
relative_uri (str):
The relative URI.

The relative URI must begin with "/" and must be
a valid HTTP relative URI. It can contain a path
and query string arguments. If the relative URI
Expand Down
17 changes: 11 additions & 6 deletions google/cloud/tasks_v2beta2/services/cloud_tasks/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ async def list_queues(
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListQueuesAsyncPager:
r"""Lists queues.

Queues are returned in lexicographical order.

.. code-block:: python
Expand Down Expand Up @@ -862,8 +863,10 @@ async def purge_queue(
metadata: Sequence[Tuple[str, str]] = (),
) -> queue.Queue:
r"""Purges a queue by deleting all of its tasks.

All tasks created before this method is called are
permanently deleted.

Purge operations can take up to one minute to take
effect. Tasks might be dispatched before the purge takes
effect. A purge is irreversible.
Expand Down Expand Up @@ -1205,6 +1208,7 @@ async def upload_queue_yaml(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Update queue list by uploading a queue.yaml file.

The queue.yaml file is supplied in the request body as a
YAML encoded string. This method was added to support
gcloud clients versions before 322.0.0. New clients
Expand Down Expand Up @@ -1313,8 +1317,8 @@ async def sample_get_iam_policy():
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested.
See the operation documentation for the
policy is being requested. See the
operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1469,8 +1473,8 @@ async def sample_set_iam_policy():
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified.
See the operation documentation for the
policy is being specified. See the
operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1613,8 +1617,8 @@ async def sample_test_iam_permissions():
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested.
See the operation documentation for the
policy detail is being requested. See
the operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -2108,6 +2112,7 @@ async def delete_task(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes a task.

A task can be deleted if it is scheduled or dispatched.
A task cannot be deleted if it has completed
successfully or permanently failed.
Expand Down
17 changes: 11 additions & 6 deletions google/cloud/tasks_v2beta2/services/cloud_tasks/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,7 @@ def list_queues(
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListQueuesPager:
r"""Lists queues.

Queues are returned in lexicographical order.

.. code-block:: python
Expand Down Expand Up @@ -1087,8 +1088,10 @@ def purge_queue(
metadata: Sequence[Tuple[str, str]] = (),
) -> queue.Queue:
r"""Purges a queue by deleting all of its tasks.

All tasks created before this method is called are
permanently deleted.

Purge operations can take up to one minute to take
effect. Tasks might be dispatched before the purge takes
effect. A purge is irreversible.
Expand Down Expand Up @@ -1430,6 +1433,7 @@ def upload_queue_yaml(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Update queue list by uploading a queue.yaml file.

The queue.yaml file is supplied in the request body as a
YAML encoded string. This method was added to support
gcloud clients versions before 322.0.0. New clients
Expand Down Expand Up @@ -1539,8 +1543,8 @@ def sample_get_iam_policy():
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested.
See the operation documentation for the
policy is being requested. See the
operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1682,8 +1686,8 @@ def sample_set_iam_policy():
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified.
See the operation documentation for the
policy is being specified. See the
operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -1823,8 +1827,8 @@ def sample_test_iam_permissions():
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested.
See the operation documentation for the
policy detail is being requested. See
the operation documentation for the
appropriate value for this field.

This corresponds to the ``resource`` field
Expand Down Expand Up @@ -2286,6 +2290,7 @@ def delete_task(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes a task.

A task can be deleted if it is scheduled or dispatched.
A task cannot be deleted if it has completed
successfully or permanently failed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@ def list_queues(
r"""Return a callable for the list queues method over gRPC.

Lists queues.

Queues are returned in lexicographical order.

Returns:
Expand Down Expand Up @@ -405,8 +406,10 @@ def purge_queue(self) -> Callable[[cloudtasks.PurgeQueueRequest], queue.Queue]:
r"""Return a callable for the purge queue method over gRPC.

Purges a queue by deleting all of its tasks.

All tasks created before this method is called are
permanently deleted.

Purge operations can take up to one minute to take
effect. Tasks might be dispatched before the purge takes
effect. A purge is irreversible.
Expand Down Expand Up @@ -505,6 +508,7 @@ def upload_queue_yaml(
r"""Return a callable for the upload queue yaml method over gRPC.

Update queue list by uploading a queue.yaml file.

The queue.yaml file is supplied in the request body as a
YAML encoded string. This method was added to support
gcloud clients versions before 322.0.0. New clients
Expand Down Expand Up @@ -734,6 +738,7 @@ def delete_task(self) -> Callable[[cloudtasks.DeleteTaskRequest], empty_pb2.Empt
r"""Return a callable for the delete task method over gRPC.

Deletes a task.

A task can be deleted if it is scheduled or dispatched.
A task cannot be deleted if it has completed
successfully or permanently failed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,7 @@ def list_queues(
r"""Return a callable for the list queues method over gRPC.

Lists queues.

Queues are returned in lexicographical order.

Returns:
Expand Down Expand Up @@ -414,8 +415,10 @@ def purge_queue(
r"""Return a callable for the purge queue method over gRPC.

Purges a queue by deleting all of its tasks.

All tasks created before this method is called are
permanently deleted.

Purge operations can take up to one minute to take
effect. Tasks might be dispatched before the purge takes
effect. A purge is irreversible.
Expand Down Expand Up @@ -518,6 +521,7 @@ def upload_queue_yaml(
r"""Return a callable for the upload queue yaml method over gRPC.

Update queue list by uploading a queue.yaml file.

The queue.yaml file is supplied in the request body as a
YAML encoded string. This method was added to support
gcloud clients versions before 322.0.0. New clients
Expand Down Expand Up @@ -753,6 +757,7 @@ def delete_task(
r"""Return a callable for the delete task method over gRPC.

Deletes a task.

A task can be deleted if it is scheduled or dispatched.
A task cannot be deleted if it has completed
successfully or permanently failed.
Expand Down
Loading