ScheduledJobRunInfo
Struct for a scheduled job run info.
| Full name | MFiles.ScheduledJobRunInfo |
|---|---|
| Proto file | mfiles/structs.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
is_running | bool | 1 | True if the job is currently running. |
next_run_utc | google.protobuf.Timestamp | 2 | The next time the job will run. Zero to indicate no next run time. |
last_run_utc | google.protobuf.Timestamp | 3 | The last time the job ran. Zero to indicate that the job has never run (or is still running for the first time). |
last_run_succeeded | bool | 4 | True if the last run at ftLastRun was successful, false otherwise. |
last_run_errors | string | 5 | Error string from the last run (if any). |
last_run_cancelled | bool | 6 | True if the job is cancelled. |
current_step | int32 | 7 | -1 or a current job step. 0 indicates the beginning. When positive, value depends on the underlying job that is being executed. Steps are numbered sequentially from 1 to forward. |
curent_step_completion | int32 | 8 | -1 or the completion percent of a current job. This is always an estimate. |
output | ScheduledJobOutputInfo | 9 | The output information on the job. Available only when the job is not running (e.g. bRunning and is false). |
Used by methods
- IRPCBackgroundOperationsAdmin.GetBackgroundOperationStatus -- Gets the run state of a background operation, such as an external object type refresh.
- IRPCScheduledJobsAdmin.AddScheduledJob -- Adds a scheduled job to the server or to the vault, depending on the job type.
- IRPCScheduledJobsAdmin.GetScheduledJob -- Gets one scheduled job and its run state.
- IRPCScheduledJobsAdmin.GetScheduledJobRunInfo -- Gets the run state of a scheduled job: running or not, last and next run, errors and progress.
- IRPCScheduledJobsAdmin.GetScheduledJobs -- Gets the scheduled jobs of the server (server-level session) or of the vault (vault session), with their run state.
- IRPCScheduledJobsAdmin.ModifyScheduledJob -- Replaces the definition of an existing scheduled job.
Used in fields
GetBackgroundOperationStatusResponse.scheduled_job_run_info-- The run state of the operation: running or not, last and next run, errors and progress.GetScheduledJobRunInfoResponse.scheduled_job_run_info-- The run state of the job.GetScheduledJobsResponse.run_infos-- The run state of each job, at the same index as injobs.AddScheduledJobResponse.run_info-- The run state of the new job.ModifyScheduledJobResponse.run_info-- The run state of the job after the change.GetScheduledJobResponse.run_info-- The run state of the job.