Skip to content

Commit

Permalink
Update documentation (via synth). (#9069)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yoshi-automation @busunkim96
yoshi-automation authored and busunkim96 committed Aug 21, 2019
1 parent 30a1b89 commit 0cfa508
Show file tree
Hide file tree
Showing 30 changed files with 1,629 additions and 1,546 deletions.
62 changes: 16 additions & 46 deletions packages/google-cloud-tasks/google/cloud/tasks_v2/gapic/cloud_tasks_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -267,9 +267,7 @@ def list_queues(
... pass
Args:
parent (str): Required.
The location name. For example:
parent (str): Required. The location name. For example:
``projects/PROJECT_ID/locations/LOCATION_ID``
filter_ (str): ``filter`` can be used to specify a subset of queues. Any ``Queue``
field can be used as a filter and several operators as supported. For
Expand Down Expand Up @@ -370,9 +368,7 @@ def get_queue(
>>> response = client.get_queue(name)
Args:
name (str): Required.
The resource name of the queue. For example:
name (str): Required. The resource name of the queue. For example:
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -456,16 +452,12 @@ def create_queue(
>>> response = client.create_queue(parent, queue)
Args:
parent (str): Required.
The location name in which the queue will be created. For example:
``projects/PROJECT_ID/locations/LOCATION_ID``
parent (str): Required. The location name in which the queue will be created. For
example: ``projects/PROJECT_ID/locations/LOCATION_ID``
The list of allowed locations can be obtained by calling Cloud Tasks'
implementation of ``ListLocations``.
queue (Union[dict, ~google.cloud.tasks_v2.types.Queue]): Required.
The queue to create.
queue (Union[dict, ~google.cloud.tasks_v2.types.Queue]): Required. The queue to create.
``Queue's name`` cannot be the same as an existing queue.
Expand Down Expand Up @@ -554,9 +546,7 @@ def update_queue(
>>> response = client.update_queue(queue)
Args:
queue (Union[dict, ~google.cloud.tasks_v2.types.Queue]): Required.
The queue to create or update.
queue (Union[dict, ~google.cloud.tasks_v2.types.Queue]): Required. The queue to create or update.
The queue's ``name`` must be specified.
Expand Down Expand Up @@ -653,9 +643,7 @@ def delete_queue(
>>> client.delete_queue(name)
Args:
name (str): Required.
The queue name. For example:
name (str): Required. The queue name. For example:
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -727,9 +715,7 @@ def purge_queue(
>>> response = client.purge_queue(name)
Args:
name (str): Required.
The queue name. For example:
name (str): Required. The queue name. For example:
``projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -803,9 +789,7 @@ def pause_queue(
>>> response = client.pause_queue(name)
Args:
name (str): Required.
The queue name. For example:
name (str): Required. The queue name. For example:
``projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -884,9 +868,7 @@ def resume_queue(
>>> response = client.resume_queue(name)
Args:
name (str): Required.
The queue name. For example:
name (str): Required. The queue name. For example:
``projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -1239,9 +1221,7 @@ def list_tasks(
... pass
Args:
parent (str): Required.
The queue name. For example:
parent (str): Required. The queue name. For example:
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID``
response_view (~google.cloud.tasks_v2.types.View): The response\_view specifies which subset of the ``Task`` will be
returned.
Expand Down Expand Up @@ -1344,9 +1324,7 @@ def get_task(
>>> response = client.get_task(name)
Args:
name (str): Required.
The task name. For example:
name (str): Required. The task name. For example:
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID``
response_view (~google.cloud.tasks_v2.types.View): The response\_view specifies which subset of the ``Task`` will be
returned.
Expand Down Expand Up @@ -1436,15 +1414,11 @@ def create_task(
>>> response = client.create_task(parent, task)
Args:
parent (str): Required.
The queue name. For example:
parent (str): Required. The queue name. For example:
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID``
The queue must already exist.
task (Union[dict, ~google.cloud.tasks_v2.types.Task]): Required.
The task to add.
task (Union[dict, ~google.cloud.tasks_v2.types.Task]): Required. The task to add.
Task names have the following format:
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID``.
Expand Down Expand Up @@ -1562,9 +1536,7 @@ def delete_task(
>>> client.delete_task(name)
Args:
name (str): Required.
The task name. For example:
name (str): Required. The task name. For example:
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -1652,9 +1624,7 @@ def run_task(
>>> response = client.run_task(name)
Args:
name (str): Required.
The task name. For example:
name (str): Required. The task name. For example:
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID``
response_view (~google.cloud.tasks_v2.types.View): The response\_view specifies which subset of the ``Task`` will be
returned.
Expand Down
Loading

0 comments on commit 0cfa508

Please sign in to comment.