Class CloudTasksClient (1.4.0)

CloudTasksClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Cloud Tasks allows developers to manage the execution of background work in their applications.

Methods

CloudTasksClient

CloudTasksClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters

Name	Description
`channel`	`grpc.Channel` DEPRECATED. A `Channel` instance through which to make calls. This argument is mutually exclusive with `credentials`; providing both will raise an exception.
`credentials`	`google.auth.credentials.Credentials` The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to `transport`; doing so will raise an exception.
`client_config`	`dict` DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.
`client_options`	`Union[dict, google.api_core.client_options.ClientOptions]` Client options used to set user options on the client. API Endpoint should be set through client_options.

acknowledge_task

acknowledge_task(name, schedule_time, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Acknowledges a pull task.

The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished.

The worker must acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a later LeaseTasks, GetTask, or ListTasks.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.task_path('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]')

TODO: Initialize schedule_time:

schedule_time = {}

client.acknowledge_task(name, schedule_time)

Parameters

Name	Description
`name`	`str` Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
`schedule_time`	`Union[dict, Timestamp]` Required. The task's current schedule time, available in the `schedule_time` returned by `LeaseTasks` response or `RenewLease` response. This restriction is to ensure that your worker currently holds the lease. If a dict is provided, it must be of the same form as the protobuf message Timestamp
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

cancel_lease

cancel_lease(name, schedule_time, response_view=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Cancel a pull task's lease.

The worker can use this method to cancel a task's lease by setting its schedule_time to now. This will make the task available to be leased to the next caller of LeaseTasks.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.task_path('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]')

TODO: Initialize schedule_time:

schedule_time = {}

response = client.cancel_lease(name, schedule_time)

Parameters

Name	Description
`name`	`str` Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
`schedule_time`	`Union[dict, Timestamp]` Required. The task's current schedule time, available in the `schedule_time` returned by `LeaseTasks` response or `RenewLease` response. This restriction is to ensure that your worker currently holds the lease. If a dict is provided, it must be of the same form as the protobuf message Timestamp
`response_view`	`View` The response_view specifies which subset of the `Task` will be returned. By default response_view is `BASIC`; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for `FULL` requires `cloudtasks.tasks.fullView` `Google IAM https://cloud.google.com/iam/`_ permission on the `Task` resource.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

create_queue

create_queue(parent, queue, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a queue.

Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not.

WARNING: Using this method may have unintended side effects if you are using an App Engine queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml <https://cloud.google.com/tasks/docs/queue-yaml>__ before using this method.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

parent = client.location_path('[PROJECT]', '[LOCATION]')

TODO: Initialize queue:

queue = {}

response = client.create_queue(parent, queue)

Parameters

Name	Description
`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, Queue]` Required. The queue to create. `Queue's name` cannot be the same as an existing queue. If a dict is provided, it must be of the same form as the protobuf message Queue
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

create_task

create_task(parent, task, response_view=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a task and adds it to a queue.

Tasks cannot be updated after creation; there is no UpdateTask command.

For App Engine queues, the maximum task size is 100KB.
For pull queues, the maximum task size is 1MB.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

parent = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]')

TODO: Initialize task:

task = {}

response = client.create_task(parent, task)

Parameters

Name	Description
`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, Task]` Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task `name`. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the `response`. If `schedule_time` is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with `ALREADY_EXISTS`. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for `1hour` after the original task was deleted or completed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for `9days` after the original task was deleted or completed. Because there is an extra lookup cost to identify duplicate task names, these `CreateTask` calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently. If a dict is provided, it must be of the same form as the protobuf message Task
`response_view`	`View` The response_view specifies which subset of the `Task` will be returned. By default response_view is `BASIC`; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for `FULL` requires `cloudtasks.tasks.fullView` `Google IAM https://cloud.google.com/iam/`_ permission on the `Task` resource.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

delete_queue

delete_queue(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes a queue.

This command will delete the queue even if it has tasks in it.

Note: If you delete a queue, a queue with the same name can't be created for 7 days.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]')

client.delete_queue(name)

Parameters

Name	Description
`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 client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

delete_task

delete_task(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.task_path('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]')

client.delete_task(name)

Parameters

Name	Description
`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 client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`CloudTasksClient`	The constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`CloudTasksClient`	The constructed client.

get_iam_policy

get_iam_policy(resource, options_=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set.

Authorization requires the following Google IAM <https://cloud.google.com/iam>__ permission on the specified resource parent:

cloudtasks.queues.getIamPolicy

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

TODO: Initialize resource:

resource = ''

response = client.get_iam_policy(resource)

Parameters

Name	Description
`resource`	`str` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
`options_`	`Union[dict, GetPolicyOptions]` OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. If a dict is provided, it must be of the same form as the protobuf message GetPolicyOptions
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

get_queue

get_queue(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a queue.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]')

response = client.get_queue(name)

Parameters

Name	Description
`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 client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

get_task

get_task(name, response_view=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets a task.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.task_path('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]')

response = client.get_task(name)

Parameters

Name	Description
`name`	`str` Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
`response_view`	`View` The response_view specifies which subset of the `Task` will be returned. By default response_view is `BASIC`; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for `FULL` requires `cloudtasks.tasks.fullView` `Google IAM https://cloud.google.com/iam/`_ permission on the `Task` resource.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

lease_tasks

lease_tasks(parent, lease_duration, max_tasks=None, response_view=None, filter_=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Leases tasks from a pull queue for lease_duration.

This method is invoked by the worker to obtain a lease. The worker must acknowledge the task via AcknowledgeTask after they have performed the work associated with the task.

The payload is intended to store data that the worker needs to perform the work associated with the task. To return the payloads in the response, set response_view to FULL.

A maximum of 10 qps of LeaseTasks requests are allowed per queue. RESOURCE_EXHAUSTED is returned when this limit is exceeded. RESOURCE_EXHAUSTED is also returned when max_tasks_dispatched_per_second is exceeded.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

parent = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]')

TODO: Initialize lease_duration:

lease_duration = {}

response = client.lease_tasks(parent, lease_duration)

Parameters

Name	Description
`parent`	`str` Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
`lease_duration`	`Union[dict, Duration]` Required. The duration of the lease. Each task returned in the `response` will have its `schedule_time` set to the current time plus the `lease_duration`. The task is leased until its `schedule_time`; thus, the task will not be returned to another `LeaseTasks` call before its `schedule_time`. After the worker has successfully finished the work associated with the task, the worker must call via `AcknowledgeTask` before the `schedule_time`. Otherwise the task will be returned to a later `LeaseTasks` call so that another worker can retry it. The maximum lease duration is 1 week. `lease_duration` will be truncated to the nearest second. If a dict is provided, it must be of the same form as the protobuf message Duration
`max_tasks`	`int` The maximum number of tasks to lease. The system will make a best effort to return as close to as `max_tasks` as possible. The largest that `max_tasks` can be is 1000. The maximum total size of a `lease tasks response` is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned.
`response_view`	`View` The response_view specifies which subset of the `Task` will be returned. By default response_view is `BASIC`; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for `FULL` requires `cloudtasks.tasks.fullView` `Google IAM https://cloud.google.com/iam/`_ permission on the `Task` resource.
`filter_`	`str` `filter` can be used to specify a subset of tasks to lease. When `filter` is set to `tag=` then the `response` will contain only tasks whose `tag` is equal to . must be less than 500 characters. When `filter` is set to `tag_function=oldest_tag()`, only tasks which have the same tag as the task with the oldest `schedule_time` will be returned. Grammar Syntax: - `filter = "tag=" tag "tag_function=" function` - `tag = string` - `function = "oldest_tag()"` The `oldest_tag()` function returns tasks which have the same tag as the oldest task (ordered by schedule time). SDK compatibility: Although the SDK allows tags to be either string or `bytes https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-`__, only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8 encoded can't be used in the `filter` and the task's `tag` will be displayed as empty in Cloud Tasks.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

list_queues

list_queues(parent, filter_=None, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists queues.

Queues are returned in lexicographical order.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

parent = client.location_path('[PROJECT]', '[LOCATION]')

Iterate over all results

for element in client.list_queues(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_queues(parent).pages: ... for element in page: ... # process element ... pass

Parameters

Name	Description
`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 example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as described in `Stackdriver's Advanced Logs Filters https://cloud.google.com/logging/docs/view/advanced_filters`__. Sample filter "app_engine_http_target: *". Note that using filters might cause fewer queues than the requested_page size to be returned.
`page_size`	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

list_tasks

list_tasks(parent, response_view=None, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists the tasks in a queue.

By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned.

The tasks may be returned in any order. The ordering may change at any time.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

parent = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]')

Iterate over all results

for element in client.list_tasks(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_tasks(parent).pages: ... for element in page: ... # process element ... pass

Parameters

Name	Description
`parent`	`str` Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
`response_view`	`View` The response_view specifies which subset of the `Task` will be returned. By default response_view is `BASIC`; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for `FULL` requires `cloudtasks.tasks.fullView` `Google IAM https://cloud.google.com/iam/`_ permission on the `Task` resource.
`page_size`	`int` The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

location_path

location_path(project, location)

Return a fully-qualified location string.

pause_queue

pause_queue(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Pauses the queue.

If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]')

response = client.pause_queue(name)

Parameters

Name	Description
`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 client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

purge_queue

purge_queue(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]')

response = client.purge_queue(name)

Parameters

Name	Description
`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 client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

queue_path

queue_path(project, location, queue)

Return a fully-qualified queue string.

renew_lease

renew_lease(name, schedule_time, lease_duration, response_view=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Renew the current lease of a pull task.

The worker can use this method to extend the lease by a new duration, starting from now. The new task lease will be returned in the task's schedule_time.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.task_path('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]')

TODO: Initialize schedule_time:

schedule_time = {}

TODO: Initialize lease_duration:

lease_duration = {}

response = client.renew_lease(name, schedule_time, lease_duration)

Parameters

Name	Description
`name`	`str` Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
`schedule_time`	`Union[dict, Timestamp]` Required. The task's current schedule time, available in the `schedule_time` returned by `LeaseTasks` response or `RenewLease` response. This restriction is to ensure that your worker currently holds the lease. If a dict is provided, it must be of the same form as the protobuf message Timestamp
`lease_duration`	`Union[dict, Duration]` Required. The desired new lease duration, starting from now. The maximum lease duration is 1 week. `lease_duration` will be truncated to the nearest second. If a dict is provided, it must be of the same form as the protobuf message Duration
`response_view`	`View` The response_view specifies which subset of the `Task` will be returned. By default response_view is `BASIC`; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for `FULL` requires `cloudtasks.tasks.fullView` `Google IAM https://cloud.google.com/iam/`_ permission on the `Task` resource.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

resume_queue

resume_queue(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Resume a queue.

This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING.

WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in Managing Cloud Tasks Scaling Risks <https://cloud.google.com/tasks/docs/manage-cloud-task-scaling>__.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.queue_path('[PROJECT]', '[LOCATION]', '[QUEUE]')

response = client.resume_queue(name)

Parameters

Name	Description
`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 client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

run_task

run_task(name, response_view=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Forces a task to run now.

When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED.

This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now.

The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target.

If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig.

RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.

RunTask cannot be called on a pull task.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

name = client.task_path('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]')

response = client.run_task(name)

Parameters

Name	Description
`name`	`str` Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
`response_view`	`View` The response_view specifies which subset of the `Task` will be returned. By default response_view is `BASIC`; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for `FULL` requires `cloudtasks.tasks.fullView` `Google IAM https://cloud.google.com/iam/`_ permission on the `Task` resource.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

set_iam_policy

set_iam_policy(resource, policy, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Sets the access control policy for a Queue. Replaces any existing policy.

Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console.

Authorization requires the following Google IAM <https://cloud.google.com/iam>__ permission on the specified resource parent:

cloudtasks.queues.setIamPolicy

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

TODO: Initialize resource:

resource = ''

TODO: Initialize policy:

policy = {}

response = client.set_iam_policy(resource, policy)

Parameters

Name	Description
`resource`	`str` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`Union[dict, Policy]` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. If a dict is provided, it must be of the same form as the protobuf message Policy
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

task_path

task_path(project, location, queue, task)

Return a fully-qualified task string.

test_iam_permissions

test_iam_permissions(resource, permissions, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

TODO: Initialize resource:

resource = ''

TODO: Initialize permissions:

permissions = []

response = client.test_iam_permissions(resource, permissions)

Parameters

Name	Description
`resource`	`str` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`list[str]` The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see `IAM Overview https://cloud.google.com/iam/docs/overview#permissions`__.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

update_queue

update_queue(queue, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates a queue.

This method creates the queue if it does not exist and updates the queue if it does exist.

Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not.

.. rubric:: Example

from google.cloud import tasks_v2beta2

client = tasks_v2beta2.CloudTasksClient()

TODO: Initialize queue:

queue = {}

response = client.update_queue(queue)

Parameters

Name	Description
`queue`	`Union[dict, Queue]` Required. The queue to create or update. The queue's `name` must be specified. Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's `name` cannot be changed. If a dict is provided, it must be of the same form as the protobuf message Queue
`update_mask`	`Union[dict, FieldMask]` A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry client library requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the client library request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the client library method.

Exceptions

Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

Class CloudTasksClient (1.4.0)

Methods

CloudTasksClient

acknowledge_task

TODO: Initialize schedule_time:

cancel_lease

TODO: Initialize schedule_time:

create_queue

TODO: Initialize queue:

create_task

TODO: Initialize task:

delete_queue

delete_task

from_service_account_file

from_service_account_json

get_iam_policy

TODO: Initialize resource:

get_queue

get_task

lease_tasks

TODO: Initialize lease_duration:

list_queues

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_tasks

Iterate over all results

Alternatively:

Iterate over results one page at a time

location_path

pause_queue

purge_queue

queue_path

renew_lease

TODO: Initialize schedule_time:

TODO: Initialize lease_duration:

resume_queue

run_task

set_iam_policy

TODO: Initialize resource:

TODO: Initialize policy:

task_path

test_iam_permissions

TODO: Initialize resource:

TODO: Initialize permissions:

update_queue

TODO: Initialize queue:

TODO: Initialize `schedule_time`:

TODO: Initialize `schedule_time`:

TODO: Initialize `queue`:

TODO: Initialize `task`:

TODO: Initialize `resource`:

TODO: Initialize `lease_duration`:

TODO: Initialize `schedule_time`:

TODO: Initialize `lease_duration`:

TODO: Initialize `resource`:

TODO: Initialize `policy`:

TODO: Initialize `resource`:

TODO: Initialize `permissions`:

TODO: Initialize `queue`: