IRPCApplicationTaskQueue.AddScheduledTask
Server integration API / specialized write session
Adds a task to a task queue that becomes available for processing at a given time.
| Service | Application task queue MFiles.IRPCApplicationTaskQueue |
|---|---|
| gRPC method | /MFiles.IRPCApplicationTaskQueue/AddScheduledTask |
| HTTP (mf-http-grpc) | POST /grpc/v1/add-scheduled-task |
| Request | AddScheduledTaskRequest |
| Response | AddScheduledTaskResponse |
| 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
- Same as AddTask, except that
ReserveTasksForProcessing
does not return the task before
activation_timestamp. - Requires a vault session and the vault right
change_full_control_role.
Request: AddScheduledTaskRequest
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 | As in AddTask; 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. |
activation_timestamp | google.protobuf.Timestamp | The earliest time (UTC) at which the task can be reserved. |
Response: AddScheduledTaskResponse
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
- AddTask -- Adds a task to a task queue, ready to be reserved at once.
- ReserveTasksForProcessing -- Reserves the next waiting task from each of the given queues for the caller to process.