Method: googleapis.cloudtasks.v2beta3.projects.locations.queues.tasks.delete

Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed.

Arguments

Parameters
name	string Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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.v2beta3.projects.locations.queues.tasks.delete
    args:
        name: ...
    result: deleteResult

JSON

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