10000 docs: Minor formatting (#369) · googleapis/python-tasks@4635f43 · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Feb 1, 2024. It is now read-only.

Commit 4635f43

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Minor formatting (#369)
* docs: Minor formatting chore: Update gapic-generator-python to v1.11.5 build: Update rules_python to 0.24.0 PiperOrigin-RevId: 563436317 Source-Link: googleapis/googleapis@42fd37b Source-Link: https://github.com/googleapis/googleapis-gen/commit/280264ca02fb9316b4237a96d0af1a2343a81a56 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 * 🦉 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 bdc98a6 commit 4635f43

File tree

21 files changed

+116
-39
lines changed

21 files changed

+116
-39
lines changed

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,7 @@ async def list_queues(
234234
metadata: Sequence[Tuple[str, str]] = (),
235235
) -> pagers.ListQueuesAsyncPager:
236236
r"""Lists queues.
237+
237238
Queues are returned in lexicographical order.
238239
239240
.. code-block:: python
@@ -860,8 +861,10 @@ async def purge_queue(
860861
metadata: Sequence[Tuple[str, str]] = (),
861862
) -> queue.Queue:
862863
r"""Purges a queue by deleting all of its tasks.
864+
863865
All tasks created before this method is called are
864866
permanently deleted.
867+
865868
Purge operations can take up to one minute to take
866869
effect. Tasks might be dispatched before the purge takes
867870
effect. A purge is irreversible.
@@ -1245,8 +1248,8 @@ async def sample_get_iam_policy():
12451248
The request object. Request message for ``GetIamPolicy`` method.
12461249
resource (:class:`str`):
12471250
REQUIRED: The resource for which the
1248-
policy is being requested.
1249-
See the operation documentation for the
1251+
policy is being requested. See the
1252+
operation documentation for the
12501253
appropriate value for this field.
12511254
12521255
This corresponds to the ``resource`` field
@@ -1401,8 +1404,8 @@ async def sample_set_iam_policy():
14011404
The request object. Request message for ``SetIamPolicy`` method.
14021405
resource (:class:`str`):
14031406
REQUIRED: The resource for which the
1404-
policy is being specified.
1405-
See the operation documentation for the
1407+
policy is being specified. See the
1408+
operation documentation for the
14061409
appropriate value for this field.
14071410
14081411
This corresponds to the ``resource`` field
@@ -1545,8 +1548,8 @@ async def sample_test_iam_permissions():
15451548
The request object. Request message for ``TestIamPermissions`` method.
15461549
resource (:class:`str`):
15471550
REQUIRED: The resource for which the
1548-
policy detail is being requested.
1549-
See the operation documentation for the
1551+
policy detail is being requested. See
1552+
the operation documentation for the
15501553
appropriate value for this field.
15511554
15521555
This corresponds to the ``resource`` field
@@ -2036,6 +2039,7 @@ async def delete_task(
20362039
metadata: Sequence[Tuple[str, str]] = (),
20372040
) -> None:
20382041
r"""Deletes a task.
2042+
20392043
A task can be deleted if it is scheduled or dispatched.
20402044
A task cannot be deleted if it has executed successfully
20412045
or permanently failed.

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -489,6 +489,7 @@ def list_queues(
489489
metadata: Sequence[Tuple[str, str]] = (),
490490
) -> pagers.ListQueuesPager:
491491
r"""Lists queues.
492+
492493
Queues are returned in lexicographical order.
493494
494495
.. code-block:: python
@@ -1085,8 +1086,10 @@ def purge_queue(
10851086
metadata: Sequence[Tuple[str, str]] = (),
10861087
) -> queue.Queue:
10871088
r"""Purges a queue by deleting all of its tasks.
1089+
10881090
All tasks created before this method is called are
10891091
permanently deleted.
1092+
10901093
Purge operations can take up to one minute to take
10911094
effect. Tasks might be dispatched before the purge takes
10921095
effect. A purge is irreversible.
@@ -1470,8 +1473,8 @@ def sample_get_iam_policy():
14701473
The request object. Request message for ``GetIamPolicy`` method.
14711474
resource (str):
14721475
REQUIRED: The resource for which the
1473-
policy is being requested.
1474-
See the operation documentation for the
1476+
policy is being requested. See the
1477+
operation documentation for the
14751478
appropriate value for this field.
14761479
14771480
This corresponds to the ``resource`` field
@@ -1613,8 +1616,8 @@ def sample_set_iam_policy():
16131616
The request object. Request message for ``SetIamPolicy`` method.
16141617
resource (str):
16151618
REQUIRED: The resource for which the
1616-
policy is being specified.
1617-
See the operation documentation for the
1619+
policy is being specified. See the
1620+
operation documentation for the
16181621
appropriate value for this field.
16191622
16201623
This corresponds to the ``resource`` field
@@ -1754,8 +1757,8 @@ def sample_test_iam_permissions():
17541757
The request object. Request message for ``TestIamPermissions`` method.
17551758
resource (str):
17561759
REQUIRED: The resource for which the
1757-
policy detail is being requested.
1758-
See the operation documentation for the
1760+
policy detail is being requested. See
1761+
the operation documentation for the
17591762
appropriate value for this field.
17601763
17611764
This corresponds to the ``resource`` field
@@ -2213,6 +2216,7 @@ def delete_task(
22132216
metadata: Sequence[Tuple[str, str]] = (),
22142217
) -> None:
22152218
r"""Deletes a task.
2219+
22162220
A task can be deleted if it is scheduled or dispatched.
22172221
A task cannot be deleted if it has executed successfully
22182222
or permanently failed.

‎google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,7 @@ def list_queues(
244244
r"""Return a callable for the list queues method over gRPC.
245245
246246
Lists queues.
247+
247248
Queues are returned in lexicographical order.
248249
249250
Returns:
@@ -405,8 +406,10 @@ def purge_queue(self) -> Callable[[cloudtasks.PurgeQueueRequest], queue.Queue]:
405406
r"""Return a callable for the purge queue method over gRPC.
406407
407408
Purges a queue by deleting all of its tasks.
409+
408410
All tasks created before this method is called are
409411
permanently deleted.
412+
410413
Purge operations can take up to one minute to take
411414
effect. Tasks might be dispatched before the purge takes
412415
effect. A purge is irreversible.
@@ -700,6 +703,7 @@ def delete_task(self) -> Callable[[cloudtasks.DeleteTaskRequest], empty_pb2.Empt
700703
r"""Return a callable for the delete task method over gRPC.
701704
702705
Deletes a task.
706+
703707
A task can be deleted if it is scheduled or dispatched.
704708
A task cannot be deleted if it has executed successfully
705709
or permanently failed.

‎google/cloud/tasks_v2/services/cloud_tasks/transports/grpc_asyncio.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ def list_queues(
249249
r"""Return a callable for the list queues method over gRPC.
250250
251251
Lists queues.
252+
252253
Queues are returned in lexicographical order.
253254
254255
Returns:
@@ -414,8 +415,10 @@ def purge_queue(
414415
r"""Return a callable for the purge queue method over gRPC.
415416
416417
Purges a queue by deleting all of its tasks.
418+
417419
All tasks created before this method is called are
418420
permanently deleted.
421+
419422
Purge operations can take up to one minute to take
420423
effect. Tasks might be dispatched before the purge takes
421424
effect. A purge is irreversible.
@@ -719,6 +722,7 @@ def delete_task(
719722
r"""Return a callable for the delete task method over gRPC.
720723
721724
Deletes a task.
725+
722726
A task can be deleted if it is scheduled or dispatched.
723727
A task cannot be deleted if it has executed successfully
724728
or permanently failed.

‎google/cloud/tasks_v2/types/queue.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,7 @@ class RateLimits(proto.Message):
320320

321321
class RetryConfig(proto.Message):
322322
r"""Retry config.
323+
323324
These settings determine when a failed task attempt is retried.
324325
325326
Attributes:

‎google/cloud/tasks_v2/types/target.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,7 @@ class AppEngineHttpRequest(proto.Message):
305305
app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
306306
relative_uri (str):
307307
The relative URI.
308+
308309
The relative URI must begin with "/" and must be
309310
a valid HTTP relative URI. It can contain a path
310311
and query string arguments. If the relative URI

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

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,7 @@ async def list_queues(
235235
metadata: Sequence[Tuple[str, str]] = (),
236236
) -> pagers.ListQueuesAsyncPager:
237237
r"""Lists queues.
238+
238239
Queues are returned in lexicographical order.
239240
240241
.. code-block:: python
@@ -862,8 +863,10 @@ async def purge_queue(
862863
metadata: Sequence[Tuple[str, str]] = (),
863864
) -> queue.Queue:
864865
r"""Purges a queue by deleting all of its tasks.
866+
865867
All tasks created before this method is called are
866868
permanently deleted.
869+
867870
Purge operations can take up to one minute to take
868871
effect. Tasks might be dispatched before the purge takes
869872
effect. A purge is irreversible.
@@ -1205,6 +1208,7 @@ async def upload_queue_yaml(
12051208
metadata: Sequence[Tuple[str, str]] = (),
12061209
) -> None:
12071210
r"""Update queue list by uploading a queue.yaml file.
1211+
12081212
The queue.yaml file is supplied in the request body as a
12091213
YAML encoded string. This method was added to support
12101214
gcloud clients versions before 322.0.0. New clients
@@ -1313,8 +1317,8 @@ async def sample_get_iam_policy():
13131317
The request object. Request message for ``GetIamPolicy`` method.
13141318
resource (:class:`str`):
13151319
REQUIRED: The resource for which the
1316-
policy is being requested.
1317-
See the operation documentation for the
1320+
policy is being requested. See the
1321+
operation documentation for the
13181322
appropriate value for this field.
13191323
13201324
This corresponds to the ``resource`` field
@@ -1469,8 +1473,8 @@ async def sample_set_iam_policy():
14691473
The request object. Request message for ``SetIamPolicy`` method.
14701474
resource (:class:`str`):
14711475
REQUIRED: The resource for which the
1472-
policy is being specified.
1473-
See the operation documentation for the
1476+
policy is being specified. See the
1477+
operation documentation for the
14741478
appropriate value for this field.
14751479
14761480
This corresponds to the ``resource`` field
@@ -1613,8 +1617,8 @@ async def sample_test_iam_permissions():
16131617
The request object. Request message for ``TestIamPermissions`` method.
16141618
resource (:class:`str`):
16151619
REQUIRED: The resource for which the
1616-
policy detail is being requested.
1617-
See the operation documentation for the
1620+
policy detail is being requested. See
1621+
the operation documentation for the
16181622
appropriate value for this field.
16191623
16201624
This corresponds to the ``resource`` field
@@ -2108,6 +2112,7 @@ async def delete_task(
21082112
metadata: Sequence[Tuple[str, str]] = (),
21092113
) -> None:
21102114
r"""Deletes a task.
2115+
21112116
A task can be deleted if it is scheduled or dispatched.
21122117
A task cannot be deleted if it has completed
21132118
successfully or permanently failed.

‎google/cloud/tasks_v2beta2/services/cloud_tasks/client.py

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -490,6 +490,7 @@ def list_queues(
490490
metadata: Sequence[Tuple[str, str]] = (),
491491
) -> pagers.ListQueuesPager:
492492
r"""Lists queues.
493+
493494
Queues are returned in lexicographical order.
494495
495496
.. code-block:: python
@@ -1087,8 +1088,10 @@ def purge_queue(
10871088
metadata: Sequence[Tuple[str, str]] = (),
10881089
) -> queue.Queue:
10891090
r"""Purges a queue by deleting all of its tasks.
1091+
10901092
All tasks created before this method is called are
10911093
permanently deleted.
1094+
10921095
Purge operations can take up to one minute to take
10931096
effect. Tasks might be dispatched before the purge takes
10941097
effect. A purge is irreversible.
@@ -1430,6 +1433,7 @@ def upload_queue_yaml(
14301433
metadata: Sequence[Tuple[str, str]] = (),
14311434
) -> None:
14321435
r"""Update queue list by uploading a queue.yaml file.
1436+
14331437
The queue.yaml file is supplied in the request body as a
14341438
YAML encoded string. This method was added to support
14351439
gcloud clients versions before 322.0.0. New clients
@@ -1539,8 +1543,8 @@ def sample_get_iam_policy():
15391543
The request object. Request message for ``GetIamPolicy`` method.
15401544
resource (str):
15411545
REQUIRED: The resource for which the
1542-
policy is being requested.
1543-
See the operation documentation for the
1546+
policy is being requested. See the
1547+
operation documentation for the
15441548
appropriate value for this field.
15451549
15461550
This corresponds to the ``resource`` field
@@ -1682,8 +1686,8 @@ def sample_set_iam_policy():
16821686
The request object. Request message for ``SetIamPolicy`` method.
16831687
resource (str):
16841688
REQUIRED: The resource for which the
1685-
policy is being specified.
1686-
See the operation documentation for the
1689+
policy is being specified. See the
1690+
operation documentation for the
16871691
appropriate value for this field.
16881692
16891693
This corresponds to the ``resource`` field
@@ -1823,8 +1827,8 @@ def sample_test_iam_permissions():
18231827
The request object. Request message for ``TestIamPermissions`` method.
18241828
resource (str):
18251829
REQUIRED: The resource for which the
1826-
policy detail is being requested.
1827-
See the operation documentation for the
1830+
policy detail is being requested. See
1831+
the operation documentation for the
18281832
appropriate value for this field.
18291833
18301834
This corresponds to the ``resource`` field
@@ -2286,6 +2290,7 @@ def delete_task(
22862290
metadata: Sequence[Tuple[str, str]] = (),
22872291
) -> None:
22882292
r"""Deletes a task.
2293+
22892294
A task can be deleted if it is scheduled or dispatched.
22902295
A task cannot be deleted if it has completed
22912296
successfully or permanently failed.

‎google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,7 @@ def list_queues(
244244
r"""Return a callable for the list queues method over gRPC.
245245
246246
Lists queues.
247+
247248
Queues are returned in lexicographical order.
248249
249250
Returns:
@@ -405,8 +406,10 @@ def purge_queue(self) -> Callable[[cloudtasks.PurgeQueueRequest], queue.Queue]:
405406
r"""Return a callable for the purge queue method over gRPC.
406407
407408
Purges a queue by deleting all of its tasks.
409+
408410
All tasks created before this method is called are
409411
permanently deleted.
412+
410413
Purge operations can take up to one minute to take
411414
effect. Tasks might be dispatched before the purge takes
412415
effect. A purge is irreversible.
@@ -505,6 +508,7 @@ def upload_queue_yaml(
505508
r"""Return a callable for the upload queue yaml method over gRPC.
506509
507510
Update queue list by uploading a queue.yaml file.
511+
508512
The queue.yaml file is supplied in the request body as a
509513
YAML encoded string. This method was added to support
510514
gcloud clients versions before 322.0.0. New clients
@@ -734,6 +738,7 @@ def delete_task(self) -> Callable[[cloudtasks.DeleteTaskRequest], empty_pb2.Empt
734738
r"""Return a callable for the delete task method over gRPC.
735739
736740
Deletes a task.
741+
737742
A task can be deleted if it is scheduled or dispatched.
738743
A task cannot be deleted if it has completed
739744
successfully or permanently failed.

‎google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc_asyncio.py

97AE
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ def list_queues(
249249
r"""Return a callable for the list queues method over gRPC.
250250
251251
Lists queues.
252+
252253
Queues are returned in lexicographical order.
253254
254255
Returns:
@@ -414,8 +415,10 @@ def purge_queue(
414415
r"""Return a callable for the purge queue method over gRPC.
415416
416417
Purges a queue by deleting all of its tasks.
418+
417419
All tasks created before this method is called are
418420
permanently deleted.
421+
419422
Purge operations can take up to one minute to take
420423
effect. Tasks might be dispatched before the purge takes
421424
effect. A purge is irreversible.
@@ -518,6 +521,7 @@ def upload_queue_yaml(
518521
r"""Return a callable for the upload queue yaml method over gRPC.
519522
520523
Update queue list by uploading a queue.yaml file.
524+
521525
The queue.yaml file is supplied in the request body as a
522526
YAML encoded string. This method was added to support
523527
gcloud clients versions before 322.0.0. New clients
@@ -753,6 +757,7 @@ def delete_task(
753757
r"""Return a callable for the delete task method over gRPC.
754758
755759
Deletes a task.
760+
756761
A task can be deleted if it is scheduled or dispatched.
757762
A task cannot be deleted if it has completed
758763
successfully or permanently failed.

0 commit comments

Comments
 (0)
0