clientapi_pve/models/
cluster_backup_get_backup_response_data_inner.rs

1/*
2 * Proxmox Virtual Environment API
3 *
4 * Generated from apidoc.js. NOT an official Proxmox specification. See https://pve.proxmox.com/pve-docs/api-viewer/ for the upstream documentation.
5 *
6 * The version of the OpenAPI document: 9.x
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct ClusterBackupGetBackupResponseDataInner {
16
17    /// Backup all known guest systems on this host.
18    #[serde(rename = "all", skip_serializing_if = "Option::is_none")]
19    pub all: Option<models::PveBoolean>,
20
21    /// Limit I/O bandwidth (in KiB/s).
22    #[serde(rename = "bwlimit", skip_serializing_if = "Option::is_none")]
23    pub bwlimit: Option<i64>,
24
25    /// Description for the Job.
26    #[serde(rename = "comment", skip_serializing_if = "Option::is_none")]
27    pub comment: Option<String>,
28
29    /// Compress dump file.
30    #[serde(rename = "compress", skip_serializing_if = "Option::is_none")]
31    pub compress: Option<models::PveCompressEnum>,
32
33    /// Store resulting files to specified directory.
34    #[serde(rename = "dumpdir", skip_serializing_if = "Option::is_none")]
35    pub dumpdir: Option<String>,
36
37    /// Enable or disable the job.
38    #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")]
39    pub enabled: Option<models::PveBoolean>,
40
41    /// Exclude specified guest systems (assumes --all)
42    #[serde(rename = "exclude", skip_serializing_if = "Option::is_none")]
43    pub exclude: Option<String>,
44
45    /// Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
46    #[serde(rename = "exclude-path", skip_serializing_if = "Option::is_none")]
47    pub exclude_path: Option<Vec<String>>,
48
49    #[serde(rename = "fleecing", skip_serializing_if = "Option::is_none")]
50    pub fleecing: Option<Box<models::ClusterBackupGetBackupResponseDataInnerFleecing>>,
51
52    /// The job ID.
53    #[serde(rename = "id")]
54    pub id: String,
55
56    /// Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.
57    #[serde(rename = "ionice", skip_serializing_if = "Option::is_none")]
58    pub ionice: Option<i32>,
59
60    /// Maximal time to wait for the global lock (minutes).
61    #[serde(rename = "lockwait", skip_serializing_if = "Option::is_none")]
62    pub lockwait: Option<i64>,
63
64    /// Deprecated: use notification targets/matchers instead. Specify when to send a notification mail
65    #[serde(rename = "mailnotification", skip_serializing_if = "Option::is_none")]
66    pub mailnotification: Option<models::PveMailnotificationEnum>,
67
68    /// Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.
69    #[serde(rename = "mailto", skip_serializing_if = "Option::is_none")]
70    pub mailto: Option<String>,
71
72    /// Backup mode.
73    #[serde(rename = "mode", skip_serializing_if = "Option::is_none")]
74    pub mode: Option<models::PveClusterBackupModeEnum>,
75
76    /// UNIX timestamp when this backup job will be executed next
77    #[serde(rename = "next-run", skip_serializing_if = "Option::is_none")]
78    pub next_run: Option<i64>,
79
80    /// Only run if executed on this node.
81    #[serde(rename = "node", skip_serializing_if = "Option::is_none")]
82    pub node: Option<String>,
83
84    /// Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\\n' and '\\\\' respectively.
85    #[serde(rename = "notes-template", skip_serializing_if = "Option::is_none")]
86    pub notes_template: Option<String>,
87
88    /// Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
89    #[serde(rename = "notification-mode", skip_serializing_if = "Option::is_none")]
90    pub notification_mode: Option<models::PveNotificationModeEnum>,
91
92    /// PBS mode used to detect file changes and switch encoding format for container backups.
93    #[serde(rename = "pbs-change-detection-mode", skip_serializing_if = "Option::is_none")]
94    pub pbs_change_detection_mode: Option<models::PvePbsChangeDetectionModeEnum>,
95
96    #[serde(rename = "performance", skip_serializing_if = "Option::is_none")]
97    pub performance: Option<Box<models::ClusterBackupGetBackupResponseDataInnerPerformance>>,
98
99    /// Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
100    #[serde(rename = "pigz", skip_serializing_if = "Option::is_none")]
101    pub pigz: Option<i64>,
102
103    /// Backup all known guest systems included in the specified pool.
104    #[serde(rename = "pool", skip_serializing_if = "Option::is_none")]
105    pub pool: Option<String>,
106
107    /// If true, mark backup(s) as protected.
108    #[serde(rename = "protected", skip_serializing_if = "Option::is_none")]
109    pub protected: Option<models::PveBoolean>,
110
111    #[serde(rename = "prune-backups", skip_serializing_if = "Option::is_none")]
112    pub prune_backups: Option<Box<models::ClusterBackupGetBackupResponseDataInnerPruneBackups>>,
113
114    /// Be quiet.
115    #[serde(rename = "quiet", skip_serializing_if = "Option::is_none")]
116    pub quiet: Option<models::PveBoolean>,
117
118    /// Prune older backups according to 'prune-backups'.
119    #[serde(rename = "remove", skip_serializing_if = "Option::is_none")]
120    pub remove: Option<models::PveBoolean>,
121
122    /// If true, the job will be run as soon as possible if it was missed while the scheduler was not running.
123    #[serde(rename = "repeat-missed", skip_serializing_if = "Option::is_none")]
124    pub repeat_missed: Option<models::PveBoolean>,
125
126    /// Backup schedule. The format is a subset of `systemd` calendar events.
127    #[serde(rename = "schedule", skip_serializing_if = "Option::is_none")]
128    pub schedule: Option<String>,
129
130    /// Use specified hook script.
131    #[serde(rename = "script", skip_serializing_if = "Option::is_none")]
132    pub script: Option<String>,
133
134    /// Exclude temporary files and logs.
135    #[serde(rename = "stdexcludes", skip_serializing_if = "Option::is_none")]
136    pub stdexcludes: Option<models::PveBoolean>,
137
138    /// Stop running backup jobs on this host.
139    #[serde(rename = "stop", skip_serializing_if = "Option::is_none")]
140    pub stop: Option<models::PveBoolean>,
141
142    /// Maximal time to wait until a guest system is stopped (minutes).
143    #[serde(rename = "stopwait", skip_serializing_if = "Option::is_none")]
144    pub stopwait: Option<i64>,
145
146    /// Store resulting file to this storage.
147    #[serde(rename = "storage", skip_serializing_if = "Option::is_none")]
148    pub storage: Option<String>,
149
150    /// Store temporary files to specified directory.
151    #[serde(rename = "tmpdir", skip_serializing_if = "Option::is_none")]
152    pub tmpdir: Option<String>,
153
154    /// The ID of the guest system you want to backup.
155    #[serde(rename = "vmid", skip_serializing_if = "Option::is_none")]
156    pub vmid: Option<String>,
157
158    /// Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count.
159    #[serde(rename = "zstd", skip_serializing_if = "Option::is_none")]
160    pub zstd: Option<i64>,
161
162
163}
164
165impl ClusterBackupGetBackupResponseDataInner {
166    pub fn new(id: String) -> ClusterBackupGetBackupResponseDataInner {
167        ClusterBackupGetBackupResponseDataInner {
168            
169            all: None,
170            
171            bwlimit: None,
172            
173            comment: None,
174            
175            compress: None,
176            
177            dumpdir: None,
178            
179            enabled: None,
180            
181            exclude: None,
182            
183            exclude_path: None,
184            
185            fleecing: None,
186            
187            id,
188            
189            ionice: None,
190            
191            lockwait: None,
192            
193            mailnotification: None,
194            
195            mailto: None,
196            
197            mode: None,
198            
199            next_run: None,
200            
201            node: None,
202            
203            notes_template: None,
204            
205            notification_mode: None,
206            
207            pbs_change_detection_mode: None,
208            
209            performance: None,
210            
211            pigz: None,
212            
213            pool: None,
214            
215            protected: None,
216            
217            prune_backups: None,
218            
219            quiet: None,
220            
221            remove: None,
222            
223            repeat_missed: None,
224            
225            schedule: None,
226            
227            script: None,
228            
229            stdexcludes: None,
230            
231            stop: None,
232            
233            stopwait: None,
234            
235            storage: None,
236            
237            tmpdir: None,
238            
239            vmid: None,
240            
241            zstd: None,
242            
243        }
244    }
245}
246
247
clientapi_pve/models/cluster_backup_get_backup_response_data_inner.rs

clientapi_pve/models/
cluster_backup_get_backup_response_data_inner.rs
