IRPCScheduledJobsAdmin.GetScheduledJob
Administration API / specialized admin session idempotent
Gets one scheduled job and its run state.
| Service | Scheduled jobs MFiles.IRPCScheduledJobsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCScheduledJobsAdmin/GetScheduledJob |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-scheduled-job |
| Request | GetScheduledJobRequest |
| Response | GetScheduledJobResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Rights depend on the job's type (see the service overview). An unknown ID fails with "Not found.".
Request: GetScheduledJobRequest
A structure that specifies the response type for the corresponding method.
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 |
|---|---|---|
scheduled_job | int32 | The ID of the job. |
Response: GetScheduledJobResponse
A structure that specifies the response type for the corresponding method.
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 |
|---|---|---|
scheduled_job | ScheduledJob | The job definition. |
scheduled_job.id | int32 | Job ID. |
scheduled_job.name | string | Job name. |
scheduled_job.is_enabled | bool | If true, the job is enabled (runs according to the specified schedule). |
scheduled_job.schedule | bytes | The schedule of this job (a serialized Task object of Task Scheduler). |
scheduled_job.type | JobType | Job type.Values: JOB_TYPE_UNINITIALIZED (0), JOB_TYPE_BACKUP (1), JOB_TYPE_RESTORE (2), JOB_TYPE_COPY_VAULT (3), JOB_TYPE_VERIFY_VAULT (4), JOB_TYPE_ARCHIVE_OBJECTS (5), JOB_TYPE_ARCHIVE_OLD_VERSIONS (6), JOB_TYPE_RESTORE_FROM_ARCHIVE (7), JOB_TYPE_OPTIMIZE_VAULT (8), JOB_TYPE_RECALCULATE_PROPERTY (9), JOB_TYPE_MIGRATE_VAULT (10), JOB_TYPE_ENCRYPT_FILE_DATA (11). |
scheduled_job.data | JobDataUnion | The job details as a union. |
scheduled_job.data.backup | BackupJob (oneof data) | Backup job. |
scheduled_job.data.restore | RestoreJob (oneof data) | Restore job. |
scheduled_job.data.copy_vault | CopyVaultJob (oneof data) | Vault copying job. |
scheduled_job.data.verify_vault | VerifyVaultJob (oneof data) | Vault verifying job. |
scheduled_job.data.archive_objects | ArchiveDocsJob (oneof data) | Archiving documents job. |
scheduled_job.data.archive_old_versions | ArchiveOldVersionsJob (oneof data) | Archiving old document versions job. |
scheduled_job.data.restore_from_archive | RestoreFromArchiveJob (oneof data) | Restoring documents from archive job. |
scheduled_job.data.optimize_vault | OptimizeVaultJob (oneof data) | Optimize the vault. |
scheduled_job.data.recalculate_property | RecalculateJob (oneof data) | Recalculate a property. |
scheduled_job.data.migrate_vault | MigrateVaultJob (oneof data) | Vault migration job. |
scheduled_job.data.encrypt_file_data | EncryptFileDataJob (oneof data) | Vault file data encryption job. |
scheduled_job.is_temporary | bool | True if the job is temporary and thus executed only once. Temporary jobs are not scheduled so their run info should not be interpreted. |
run_info | ScheduledJobRunInfo | The run state of the job. |
run_info.is_running | bool | True if the job is currently running. |
run_info.next_run_utc | google.protobuf.Timestamp | The next time the job will run. Zero to indicate no next run time. |
run_info.last_run_utc | google.protobuf.Timestamp | The last time the job ran. Zero to indicate that the job has never run (or is still running for the first time). |
run_info.last_run_succeeded | bool | True if the last run at ftLastRun was successful, false otherwise. |
run_info.last_run_errors | string | Error string from the last run (if any). |
run_info.last_run_cancelled | bool | True if the job is cancelled. |
run_info.current_step | int32 | -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. |
run_info.curent_step_completion | int32 | -1 or the completion percent of a current job. This is always an estimate. |
run_info.output | ScheduledJobOutputInfo | The output information on the job. Available only when the job is not running (e.g. bRunning and is false). |
run_info.output.id | int32 | Job ID. |
run_info.output.message | string | General output info message. |
run_info.output.type | JobType | Job type.Values: JOB_TYPE_UNINITIALIZED (0), JOB_TYPE_BACKUP (1), JOB_TYPE_RESTORE (2), JOB_TYPE_COPY_VAULT (3), JOB_TYPE_VERIFY_VAULT (4), JOB_TYPE_ARCHIVE_OBJECTS (5), JOB_TYPE_ARCHIVE_OLD_VERSIONS (6), JOB_TYPE_RESTORE_FROM_ARCHIVE (7), JOB_TYPE_OPTIMIZE_VAULT (8), JOB_TYPE_RECALCULATE_PROPERTY (9), JOB_TYPE_MIGRATE_VAULT (10), JOB_TYPE_ENCRYPT_FILE_DATA (11). |
run_info.output.data | JobOutputInfoDataUnion | The job output info details as a union. |
Related methods
- GetScheduledJobRunInfo -- Gets the run state of a scheduled job: running or not, last and next run, errors and progress.