IRPCApplicationTaskQueue.ClearAndDestroyTaskQueue
Server integration API / specialized write session
Deletes a task queue and all of its tasks.
| Service | Application task queue MFiles.IRPCApplicationTaskQueue |
|---|---|
| gRPC method | /MFiles.IRPCApplicationTaskQueue/ClearAndDestroyTaskQueue |
| HTTP (mf-http-grpc) | POST /grpc/v1/clear-and-destroy-task-queue |
| Request | ClearAndDestroyTaskQueueRequest |
| Response | ClearAndDestroyTaskQueueResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Destructive. Deletes the queue and its tasks, whatever their state; meant for development and testing. Vault applications that still use the queue lose their work.
- Requires a vault session and the vault right
change_full_control_role. Internal queue IDs are refused with "Access denied.".
Request: ClearAndDestroyTaskQueueRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
queue_id | string | The ID of the queue to delete. |
Response: ClearAndDestroyTaskQueueResponse
No fields.