Skip to content

Commit 2ae830b

Browse files
yoshi-automationemar-kar
authored andcommitted
Update documentation (via synth). (googleapis#9069)
1 parent 95de884 commit 2ae830b

30 files changed

Lines changed: 1629 additions & 1546 deletions

tasks/google/cloud/tasks_v2/gapic/cloud_tasks_client.py

Lines changed: 16 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -267,9 +267,7 @@ def list_queues(
267267
... pass
268268
269269
Args:
270-
parent (str): Required.
271-
272-
The location name. For example:
270+
parent (str): Required. The location name. For example:
273271
``projects/PROJECT_ID/locations/LOCATION_ID``
274272
filter_ (str): ``filter`` can be used to specify a subset of queues. Any ``Queue``
275273
field can be used as a filter and several operators as supported. For
@@ -370,9 +368,7 @@ def get_queue(
370368
>>> response = client.get_queue(name)
371369
372370
Args:
373-
name (str): Required.
374-
375-
The resource name of the queue. For example:
371+
name (str): Required. The resource name of the queue. For example:
376372
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID``
377373
retry (Optional[google.api_core.retry.Retry]): A retry object used
378374
to retry requests. If ``None`` is specified, requests will
@@ -456,16 +452,12 @@ def create_queue(
456452
>>> response = client.create_queue(parent, queue)
457453
458454
Args:
459-
parent (str): Required.
460-
461-
The location name in which the queue will be created. For example:
462-
``projects/PROJECT_ID/locations/LOCATION_ID``
455+
parent (str): Required. The location name in which the queue will be created. For
456+
example: ``projects/PROJECT_ID/locations/LOCATION_ID``
463457
464458
The list of allowed locations can be obtained by calling Cloud Tasks'
465459
implementation of ``ListLocations``.
466-
queue (Union[dict, ~google.cloud.tasks_v2.types.Queue]): Required.
467-
468-
The queue to create.
460+
queue (Union[dict, ~google.cloud.tasks_v2.types.Queue]): Required. The queue to create.
469461
470462
``Queue's name`` cannot be the same as an existing queue.
471463
@@ -554,9 +546,7 @@ def update_queue(
554546
>>> response = client.update_queue(queue)
555547
556548
Args:
557-
queue (Union[dict, ~google.cloud.tasks_v2.types.Queue]): Required.
558-
559-
The queue to create or update.
549+
queue (Union[dict, ~google.cloud.tasks_v2.types.Queue]): Required. The queue to create or update.
560550
561551
The queue's ``name`` must be specified.
562552
@@ -653,9 +643,7 @@ def delete_queue(
653643
>>> client.delete_queue(name)
654644
655645
Args:
656-
name (str): Required.
657-
658-
The queue name. For example:
646+
name (str): Required. The queue name. For example:
659647
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID``
660648
retry (Optional[google.api_core.retry.Retry]): A retry object used
661649
to retry requests. If ``None`` is specified, requests will
@@ -727,9 +715,7 @@ def purge_queue(
727715
>>> response = client.purge_queue(name)
728716
729717
Args:
730-
name (str): Required.
731-
732-
The queue name. For example:
718+
name (str): Required. The queue name. For example:
733719
``projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID``
734720
retry (Optional[google.api_core.retry.Retry]): A retry object used
735721
to retry requests. If ``None`` is specified, requests will
@@ -803,9 +789,7 @@ def pause_queue(
803789
>>> response = client.pause_queue(name)
804790
805791
Args:
806-
name (str): Required.
807-
808-
The queue name. For example:
792+
name (str): Required. The queue name. For example:
809793
``projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID``
810794
retry (Optional[google.api_core.retry.Retry]): A retry object used
811795
to retry requests. If ``None`` is specified, requests will
@@ -884,9 +868,7 @@ def resume_queue(
884868
>>> response = client.resume_queue(name)
885869
886870
Args:
887-
name (str): Required.
888-
889-
The queue name. For example:
871+
name (str): Required. The queue name. For example:
890872
``projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID``
891873
retry (Optional[google.api_core.retry.Retry]): A retry object used
892874
to retry requests. If ``None`` is specified, requests will
@@ -1239,9 +1221,7 @@ def list_tasks(
12391221
... pass
12401222
12411223
Args:
1242-
parent (str): Required.
1243-
1244-
The queue name. For example:
1224+
parent (str): Required. The queue name. For example:
12451225
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID``
12461226
response_view (~google.cloud.tasks_v2.types.View): The response\_view specifies which subset of the ``Task`` will be
12471227
returned.
@@ -1344,9 +1324,7 @@ def get_task(
13441324
>>> response = client.get_task(name)
13451325
13461326
Args:
1347-
name (str): Required.
1348-
1349-
The task name. For example:
1327+
name (str): Required. The task name. For example:
13501328
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID``
13511329
response_view (~google.cloud.tasks_v2.types.View): The response\_view specifies which subset of the ``Task`` will be
13521330
returned.
@@ -1436,15 +1414,11 @@ def create_task(
14361414
>>> response = client.create_task(parent, task)
14371415
14381416
Args:
1439-
parent (str): Required.
1440-
1441-
The queue name. For example:
1417+
parent (str): Required. The queue name. For example:
14421418
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID``
14431419
14441420
The queue must already exist.
1445-
task (Union[dict, ~google.cloud.tasks_v2.types.Task]): Required.
1446-
1447-
The task to add.
1421+
task (Union[dict, ~google.cloud.tasks_v2.types.Task]): Required. The task to add.
14481422
14491423
Task names have the following format:
14501424
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID``.
@@ -1562,9 +1536,7 @@ def delete_task(
15621536
>>> client.delete_task(name)
15631537
15641538
Args:
1565-
name (str): Required.
1566-
1567-
The task name. For example:
1539+
name (str): Required. The task name. For example:
15681540
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID``
15691541
retry (Optional[google.api_core.retry.Retry]): A retry object used
15701542
to retry requests. If ``None`` is specified, requests will
@@ -1652,9 +1624,7 @@ def run_task(
16521624
>>> response = client.run_task(name)
16531625
16541626
Args:
1655-
name (str): Required.
1656-
1657-
The task name. For example:
1627+
name (str): Required. The task name. For example:
16581628
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID``
16591629
response_view (~google.cloud.tasks_v2.types.View): The response\_view specifies which subset of the ``Task`` will be
16601630
returned.

0 commit comments

Comments
 (0)