IRPCApplicationTaskQueue.AddScheduledTask

View as Markdown

Server integration API / specialized write session

Adds a task to a task queue that becomes available for processing at a given time.

ServiceApplication task queue MFiles.IRPCApplicationTaskQueue
gRPC method/MFiles.IRPCApplicationTaskQueue/AddScheduledTask
HTTP (mf-http-grpc)POST /grpc/v1/add-scheduled-task
RequestAddScheduledTaskRequest
ResponseAddScheduledTaskResponse
Book and levelServer integration API, specialized
Kindwrite
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentno
Returns metadata structure versionno
Streamingnone (unary)

Remarks

Request: AddScheduledTaskRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
queue_idstringThe ID of the queue.
restore_to_waiting_timeout_in_minutesint32As in AddTask; 0 or less means 5 minutes.
task_typestringA free-form type name that tells the processor how to read task_data.
task_databytesThe payload of the task.
activation_timestampgoogle.protobuf.TimestampThe 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.

FieldTypeDescription
task_idstringThe ID of the new task, a decimal number as a string.