Cloud Tasks API Connector Overview

The Workflows connector defines the built-infunctions that can be used to access other Google Cloud products within aworkflow.

This page provides an overview of the individual connector.There is no need to import or load connector libraries in a workflow—connectorswork out of the box when used in a call step.

Cloud Tasks API

Manages the execution of large numbers of distributed requests.To learn more, see theCloud Tasks API documentation.

Cloud Tasks connector sample

YAML

# This workflow demonstrates how to use the Cloud Tasks connector:# Create a Cloud Tasks queue and create a task in that queue# Delete the task and then the queue# Expected output: "SUCCESS"-init:assign:-project_id:${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}-location_id:"us-central1"-queue_id:"example-queue-id"-task_id:"example-task-id"# Replace TIME_IN_ZULU_FORMAT and CLOUD_FUNCTION_URL placeholders-schedule_time:"TIME_IN_ZULU_FORMAT"# time in RFC3339 UTC "Zulu" format (eg. "2014-10-02T15:01:23Z")-cloud_function_url:"CLOUD_FUNCTION_URL"# Cloud Function URL to be triggered by the task-create_queue:call:googleapis.cloudtasks.v2.projects.locations.queues.createargs:parent:${"projects/" + project_id + "/locations/" + location_id}body:name:${"projects/" + project_id + "/locations/" + location_id + "/queues/" + queue_id}result:queue-create_task:call:googleapis.cloudtasks.v2.projects.locations.queues.tasks.createargs:parent:${queue.name}body:task:name:${queue.name + "/tasks/" + task_id}scheduleTime:${schedule_time}httpRequest:url:${cloud_function_url}httpMethod:"GET"result:task-get_task:call:googleapis.cloudtasks.v2.projects.locations.queues.tasks.getargs:name:${task.name}-delete_task:call:googleapis.cloudtasks.v2.projects.locations.queues.tasks.deleteargs:name:${task.name}-delete_queue:call:googleapis.cloudtasks.v2.projects.locations.queues.deleteargs:name:${queue.name}-the_end:return:"SUCCESS"

JSON

[{"init":{"assign":[{"project_id":"${sys.get_env(\"GOOGLE_CLOUD_PROJECT_ID\")}"},{"location_id":"us-central1"},{"queue_id":"example-queue-id"},{"task_id":"example-task-id"},{"schedule_time":"TIME_IN_ZULU_FORMAT"},{"cloud_function_url":"CLOUD_FUNCTION_URL"}]}},{"create_queue":{"call":"googleapis.cloudtasks.v2.projects.locations.queues.create","args":{"parent":"${\"projects/\" + project_id + \"/locations/\" + location_id}","body":{"name":"${\"projects/\" + project_id + \"/locations/\" + location_id + \"/queues/\" + queue_id}"}},"result":"queue"}},{"create_task":{"call":"googleapis.cloudtasks.v2.projects.locations.queues.tasks.create","args":{"parent":"${queue.name}","body":{"task":{"name":"${queue.name + \"/tasks/\" + task_id}","scheduleTime":"${schedule_time}","httpRequest":{"url":"${cloud_function_url}","httpMethod":"GET"}}}},"result":"task"}},{"get_task":{"call":"googleapis.cloudtasks.v2.projects.locations.queues.tasks.get","args":{"name":"${task.name}"}}},{"delete_task":{"call":"googleapis.cloudtasks.v2.projects.locations.queues.tasks.delete","args":{"name":"${task.name}"}}},{"delete_queue":{"call":"googleapis.cloudtasks.v2.projects.locations.queues.delete","args":{"name":"${queue.name}"}}},{"the_end":{"return":"SUCCESS"}}]

Module: googleapis.cloudtasks.v2.projects.locations

Functions
getGets information about a location.
listLists information about the supported locations for this service.

Module: googleapis.cloudtasks.v2.projects.locations.queues

Functions
createCreates a queue. Queues created with this method allow tasks to live fora maximum of 31 days. After a task is 31 days old, the task will bedeleted regardless of whether it was dispatched or not. WARNING: Usingthis method may have unintended side effects if you are using an AppEnginequeue.yaml orqueue.xml file to manage your queues. ReadOverview of Queue Management andqueue.yaml before usingthis method.
deleteDeletes a queue. This command will delete the queue even if it has tasksin it. Note: If you delete a queue, a queue with the same name can't becreated for 7 days. WARNING: Using this method may have unintended sideeffects if you are using an App Enginequeue.yaml orqueue.xml fileto manage your queues. ReadOverview of Queue Management andqueue.yaml before usingthis method.
getGets a queue.
getIamPolicyGets the access control policy for a Queue. Returns an empty policy ifthe resource exists and does not have a policy set. Authorizationrequires the followingGoogle IAMpermission on the specified resource parent: *cloudtasks.queues.getIamPolicy
listLists queues. Queues are returned in lexicographical order.
patchUpdates a queue. This method creates the queue if it does not exist andupdates the queue if it does exist. Queues created with this methodallow tasks to live for a maximum of 31 days. After a task is 31 daysold, the task will be deleted regardless of whether it was dispatched ornot. WARNING: Using this method may have unintended side effects if youare using an App Enginequeue.yaml orqueue.xml file to manage yourqueues. ReadOverview of Queue Management andqueue.yaml before usingthis method.
pausePauses the queue. If a queue is paused then the system will stopdispatching tasks until the queue is resumed via ResumeQueue. Tasks canstill be added when the queue is paused. A queue is paused if its stateis PAUSED.
purgePurges a queue by deleting all of its tasks. All tasks created beforethis method is called are permanently deleted. Purge operations can takeup to one minute to take effect. Tasks might be dispatched before thepurge takes effect. A purge is irreversible.
resumeResume a queue. This method resumes a queue after it has been PAUSED orDISABLED. The state of a queue is stored in the queue's state; aftercalling this method it will be set to RUNNING. WARNING: Resuming manyhigh-QPS queues at the same time can lead to target overloading. If youare resuming high-QPS queues, follow the 500/50/5 pattern described inManaging Cloud Tasks ScalingRisks.
setIamPolicySets the access control policy for a Queue. Replaces any existingpolicy. Note: The Cloud Console does not check queue-level IAMpermissions yet. Project-level permissions are required to use the CloudConsole. Authorization requires the followingGoogleIAM permission on the specified resourceparent: *cloudtasks.queues.setIamPolicy
testIamPermissionsReturns permissions that a caller has on a Queue. If the resource doesnot exist, this will return an empty set of permissions, not a NOT_FOUNDerror. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Module: googleapis.cloudtasks.v2.projects.locations.queues.tasks

Functions
createCreates a task and adds it to a queue. Tasks cannot be updated aftercreation; there is no UpdateTask command. * The maximum task size is100KB.
deleteDeletes a task. A task can be deleted if it is scheduled or dispatched.A task cannot be deleted if it has executed successfully or permanentlyfailed.
getGets a task.
listLists the tasks in a queue. By default, only the BASIC view is retrieveddue to performance considerations; response_view controls the subset ofinformation which is returned. The tasks may be returned in any order.The ordering may change at any time.
runForces a task to run now. When this method is called, Cloud Tasks willdispatch the task, even if the task is already running, the queue hasreached its RateLimits or is PAUSED. This command is meant to be usedfor manual debugging. For example, RunTask can be used to retry a failedtask after a fix has been made or to manually force a task to bedispatched now. The dispatched task is returned. That is, the task thatis returned contains the status after the task is dispatched but beforethe task is received by its target. If Cloud Tasks receives a successfulresponse from the task's target, then the task will be deleted;otherwise the task's schedule_time will be reset to the time thatRunTask was called plus the retry delay specified in the queue'sRetryConfig. RunTask returns NOT_FOUND when it is called on a task thathas already succeeded or permanently failed.

Module: googleapis.cloudtasks.v2beta3.projects.locations

Functions
getGets information about a location.
listLists information about the supported locations for this service.

Module: googleapis.cloudtasks.v2beta3.projects.locations.queues

Functions
createCreates a queue. Queues created with this method allow tasks to live fora maximum of 31 days. After a task is 31 days old, the task will bedeleted regardless of whether it was dispatched or not. WARNING: Usingthis method may have unintended side effects if you are using an AppEnginequeue.yaml orqueue.xml file to manage your queues. ReadOverview of Queue Management andqueue.yaml before usingthis method.
deleteDeletes a queue. This command will delete the queue even if it has tasksin it. Note: If you delete a queue, a queue with the same name can't becreated for 7 days. WARNING: Using this method may have unintended sideeffects if you are using an App Enginequeue.yaml orqueue.xml fileto manage your queues. ReadOverview of Queue Management andqueue.yaml before usingthis method.
getGets a queue.
getIamPolicyGets the access control policy for a Queue. Returns an empty policy ifthe resource exists and does not have a policy set. Authorizationrequires the followingGoogle IAMpermission on the specified resource parent: *cloudtasks.queues.getIamPolicy
listLists queues. Queues are returned in lexicographical order.
patchUpdates a queue. This method creates the queue if it does not exist andupdates the queue if it does exist. Queues created with this methodallow tasks to live for a maximum of 31 days. After a task is 31 daysold, the task will be deleted regardless of whether it was dispatched ornot. WARNING: Using this method may have unintended side effects if youare using an App Enginequeue.yaml orqueue.xml file to manage yourqueues. ReadOverview of Queue Management andqueue.yaml before usingthis method.
pausePauses the queue. If a queue is paused then the system will stopdispatching tasks until the queue is resumed via ResumeQueue. Tasks canstill be added when the queue is paused. A queue is paused if its stateis PAUSED.
purgePurges a queue by deleting all of its tasks. All tasks created beforethis method is called are permanently deleted. Purge operations can takeup to one minute to take effect. Tasks might be dispatched before thepurge takes effect. A purge is irreversible.
resumeResume a queue. This method resumes a queue after it has been PAUSED orDISABLED. The state of a queue is stored in the queue's state; aftercalling this method it will be set to RUNNING. WARNING: Resuming manyhigh-QPS queues at the same time can lead to target overloading. If youare resuming high-QPS queues, follow the 500/50/5 pattern described inManaging Cloud Tasks ScalingRisks.
setIamPolicySets the access control policy for a Queue. Replaces any existingpolicy. Note: The Cloud Console does not check queue-level IAMpermissions yet. Project-level permissions are required to use the CloudConsole. Authorization requires the followingGoogleIAM permission on the specified resourceparent: *cloudtasks.queues.setIamPolicy
testIamPermissionsReturns permissions that a caller has on a Queue. If the resource doesnot exist, this will return an empty set of permissions, not a NOT_FOUNDerror. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Module: googleapis.cloudtasks.v2beta3.projects.locations.queues.tasks

Functions
createCreates a task and adds it to a queue. Tasks cannot be updated aftercreation; there is no UpdateTask command. * The maximum task size is100KB.
deleteDeletes a task. A task can be deleted if it is scheduled or dispatched.A task cannot be deleted if it has executed successfully or permanentlyfailed.
getGets a task.
listLists the tasks in a queue. By default, only the BASIC view is retrieveddue to performance considerations; response_view controls the subset ofinformation which is returned. The tasks may be returned in any order.The ordering may change at any time.
runForces a task to run now. When this method is called, Cloud Tasks willdispatch the task, even if the task is already running, the queue hasreached its RateLimits or is PAUSED. This command is meant to be usedfor manual debugging. For example, RunTask can be used to retry a failedtask after a fix has been made or to manually force a task to bedispatched now. The dispatched task is returned. That is, the task thatis returned contains the status after the task is dispatched but beforethe task is received by its target. If Cloud Tasks receives a successfulresponse from the task's target, then the task will be deleted;otherwise the task's schedule_time will be reset to the time thatRunTask was called plus the retry delay specified in the queue'sRetryConfig. RunTask returns NOT_FOUND when it is called on a task thathas already succeeded or permanently failed.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.