Method: googleapis.cloudtasks.v2.projects.locations.queues.delete

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. 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 before using this method.

Arguments

Parameters
name

string

Required. The queue name. For example: projects/PROJECT_ID/locations/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 will be empty.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- delete:
    call: googleapis.cloudtasks.v2.projects.locations.queues.delete
    args:
        name: ...
    result: deleteResult

JSON

[
  {
    "delete": {
      "call": "googleapis.cloudtasks.v2.projects.locations.queues.delete",
      "args": {
        "name": "..."
      },
      "result": "deleteResult"
    }
  }
]