Stay organized with collections
Save and categorize content based on your preferences.
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.
Arguments
Parameters
name
string
Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
Response
If successful, the response contains an instance of Queue.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Method: googleapis.cloudtasks.v2.projects.locations.queues.pause\n\nPauses the queue. If a queue is paused then the system will stop\ndispatching tasks until the queue is resumed via ResumeQueue. Tasks can\nstill be added when the queue is paused. A queue is paused if its state\nis PAUSED.\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`Queue`](/workflows/docs/reference/googleapis/cloudtasks/v2/Overview#Queue).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/tasks/docs/reference/rest/v2/projects.locations.queues/pause). \n\n### YAML\n\n```yaml\n- pause:\n call: googleapis.cloudtasks.v2.projects.locations.queues.pause\n args:\n name: ...\n result: pauseResult\n```\n\n### JSON\n\n```json\n[\n {\n \"pause\": {\n \"call\": \"googleapis.cloudtasks.v2.projects.locations.queues.pause\",\n \"args\": {\n \"name\": \"...\"\n },\n \"result\": \"pauseResult\"\n }\n }\n]\n```"]]