IRPCApplicationTaskQueue.AddTask
Server integration API / specialized write session
Adds a task to a task queue, ready to be reserved at once.
| Service | Application task queue MFiles.IRPCApplicationTaskQueue |
|---|---|
| gRPC method | /MFiles.IRPCApplicationTaskQueue/AddTask |
| HTTP (mf-http-grpc) | POST /grpc/v1/add-task |
| Request | AddTaskRequest |
| Response | AddTaskResponse |
| 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
- The queue must have been opened with OpenTaskQueue; otherwise the call fails with "The task queue is not open.".
- Requires a vault session and the vault right
change_full_control_role.
Request: AddTaskRequest
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. |
restore_to_waiting_timeout_in_minutes | int32 | How long the task may stay in progress without an UpdateTask call before it goes back to waiting. 0 or less means 5 minutes. |
task_type | string | A free-form type name that tells the processor how to read task_data. |
task_data | bytes | The payload of the task. |
Response: AddTaskResponse
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 |
|---|---|---|
task_id | string | The ID of the new task, a decimal number as a string. |
Related methods
- OpenTaskQueue -- Creates a task queue if it does not exist, or confirms an existing one.