IRPCBackgroundOperationsAdmin.QueueAndGetLatestAsyncTask

View as Markdown

Administration API / specialized admin session idempotent

Gets the newest asynchronous task of the vault and asks the server to queue pending tasks for running now.

ServiceBackground operations MFiles.IRPCBackgroundOperationsAdmin
gRPC method/MFiles.IRPCBackgroundOperationsAdmin/QueueAndGetLatestAsyncTask
HTTP (mf-http-grpc)POST /grpc/v1/queue-and-get-latest-async-task
RequestQueueAndGetLatestAsyncTaskRequest
ResponseQueueAndGetLatestAsyncTaskResponse
Book and levelAdministration API, specialized
Kindadmin
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionno
Streamingnone (unary)

Remarks

Request: QueueAndGetLatestAsyncTaskRequest

No fields.

Response: QueueAndGetLatestAsyncTaskResponse

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

FieldTypeDescription
is_availableboolTrue if the vault has at least one asynchronous task.
async_taskAsyncTaskThe newest task (highest ID). Valid only if is_available is true.
async_task.idint64Task ID.
async_task.typestringTask type name.
async_task.definitionstringThe display string of the task definition.
async_task.is_runningboolTrue if the task is currently running.
async_task.last_run_started_utcgoogle.protobuf.TimestampThe last time the task ran started. Zero to indicate that the task has never run (or is still running for the first time).
async_task.last_run_ended_utcgoogle.protobuf.TimestampThe last time the task ran ended. Zero to indicate that the task has never run (or is still running for the first time).
async_task.last_run_succeededboolTrue if the last run was successful, false otherwise.
async_task.last_run_errorsstringError string from the last run (if any).
async_task.canceledboolTrue if the task is canceled.
async_task.progress_infostringThe progress info string of the task.
async_task.output_infostringThe output info string of the task.