From: Thomas Lamprecht <t.lamprecht@proxmox.com>
Date: Wed, 28 Oct 2020 14:32:28 +0000 (+0100)
Subject: document verify job structs
X-Git-Tag: v0.9.2~11
X-Git-Url: https://git.proxmox.com/?p=proxmox-backup.git;a=commitdiff_plain;h=c4a45ec744f8e304e8f404e7c9923559689c483c

document verify job structs

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
---

diff --git a/src/config/verify.rs b/src/config/verify.rs
index aa6b05c9..5d326d9b 100644
--- a/src/config/verify.rs
+++ b/src/config/verify.rs
@@ -52,15 +52,21 @@ lazy_static! {
 #[derive(Serialize,Deserialize)]
 /// Verification Job
 pub struct VerificationJobConfig {
+    /// unique ID to address this job
     pub id: String,
+    /// the datastore ID this verificaiton job affects
     pub store: String,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// if not set to false, check the age of the last snapshot verification to filter
+    /// out recent ones, depending on 'outdated_after' configuration.
     pub ignore_verified: Option<bool>,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// Reverify snapshots after X days, never if 0. Ignored if 'ignore_verified' is false.
     pub outdated_after: Option<i64>,
     #[serde(skip_serializing_if="Option::is_none")]
     pub comment: Option<String>,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// when to schedule this job in calendar event notation
     pub schedule: Option<String>,
 }
 
@@ -115,23 +121,33 @@ pub struct VerificationJobConfig {
 #[derive(Serialize,Deserialize)]
 /// Status of Verification Job
 pub struct VerificationJobStatus {
+    /// unique ID to address this job
     pub id: String,
+    /// the datastore ID this verificaiton job affects
     pub store: String,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// if not set to false, check the age of the last snapshot verification to filter
+    /// out recent ones, depending on 'outdated_after' configuration.
     pub ignore_verified: Option<bool>,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// Reverify snapshots after X days, never if 0. Ignored if 'ignore_verified' is false.
     pub outdated_after: Option<i64>,
     #[serde(skip_serializing_if="Option::is_none")]
     pub comment: Option<String>,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// when to schedule this job in calendar event notation
     pub schedule: Option<String>,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// The timestamp when this job runs the next time.
     pub next_run: Option<i64>,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// The state of the last scheduled run, if any
     pub last_run_state: Option<String>,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// The task UPID of the last scheduled run, if any
     pub last_run_upid: Option<String>,
     #[serde(skip_serializing_if="Option::is_none")]
+    /// When the last run was finished, combined with UPID.starttime one can calculate the duration
     pub last_run_endtime: Option<i64>,
 }