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.
Arguments
Parameters | |
---|---|
name |
Required. The queue name. For example:
|
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.
YAML
- purge: call: googleapis.cloudtasks.v2beta3.projects.locations.queues.purge args: name: ... result: purgeResult
JSON
[ { "purge": { "call": "googleapis.cloudtasks.v2beta3.projects.locations.queues.purge", "args": { "name": "..." }, "result": "purgeResult" } } ]