proxmox-api 0.2.0

Rust bindings for the Proxmox VE HTTP API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

#[derive(Debug, Clone)]
pub struct ExportClient<T> {
    client: T,
    path: String,
}
impl<T> ExportClient<T>
where
    T: crate::client::Client,
{
    pub fn new(client: T, parent_path: &str) -> Self {
        Self {
            client,
            path: format!("{}{}", parent_path, "/export"),
        }
    }
}
impl<T> ExportClient<T>
where
    T: crate::client::Client,
{
    #[doc = "Retrieve metrics of the cluster."]
    #[doc = ""]
    #[doc = "Permission check: perm(\"/\", [\"Sys.Audit\"])"]
    pub async fn get(&self, params: GetParams) -> Result<GetOutput, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &params).await
    }
}
impl DataGetOutputDataItems {
    pub fn new(id: String, metric: String, timestamp: i64, ty: Type, value: f64) -> Self {
        Self {
            id,
            metric,
            timestamp,
            ty,
            value,
        }
    }
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize)]
pub struct DataGetOutputDataItems {
    #[doc = "Unique identifier for this metric object, for instance 'node/\\\\<nodename\\\\>' or 'qemu/\\\\<vmid\\\\>'."]
    #[doc = ""]
    pub id: String,
    #[doc = "Name of the metric."]
    #[doc = ""]
    pub metric: String,
    #[serde(
        serialize_with = "crate::types::serialize_int",
        deserialize_with = "crate::types::deserialize_int"
    )]
    #[doc = "Time at which this metric was observed"]
    #[doc = ""]
    pub timestamp: i64,
    #[serde(rename = "type")]
    #[doc = "Type of the metric."]
    #[doc = ""]
    pub ty: Type,
    #[serde(
        serialize_with = "crate::types::serialize_number",
        deserialize_with = "crate::types::deserialize_number"
    )]
    #[doc = "Metric value."]
    #[doc = ""]
    pub value: f64,
}
impl GetOutput {
    pub fn new(data: Vec<DataGetOutputDataItems>) -> Self {
        Self { data }
    }
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize)]
pub struct GetOutput {
    #[serde(skip_serializing_if = "::std::vec::Vec::is_empty", default)]
    #[doc = "Array of system metrics. Metrics are sorted by their timestamp."]
    #[doc = ""]
    pub data: Vec<DataGetOutputDataItems>,
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize, Default)]
pub struct GetParams {
    #[serde(
        serialize_with = "crate::types::serialize_bool_optional",
        deserialize_with = "crate::types::deserialize_bool_optional"
    )]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Also return historic values. Returns full available metric history unless `start-time` is also set"]
    #[doc = ""]
    pub history: Option<bool>,
    #[serde(rename = "local-only")]
    #[serde(
        serialize_with = "crate::types::serialize_bool_optional",
        deserialize_with = "crate::types::deserialize_bool_optional"
    )]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Only return metrics for the current node instead of the whole cluster"]
    #[doc = ""]
    pub local_only: Option<bool>,
    #[serde(rename = "node-list")]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Only return metrics from nodes passed as comma-separated list"]
    #[doc = ""]
    pub node_list: Option<String>,
    #[serde(rename = "start-time")]
    #[serde(
        serialize_with = "crate::types::serialize_int_optional",
        deserialize_with = "crate::types::deserialize_int_optional"
    )]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Only include metrics with a timestamp \\\\> start-time."]
    #[doc = ""]
    pub start_time: Option<i64>,
    #[serde(
        flatten,
        default,
        skip_serializing_if = "::std::collections::HashMap::is_empty"
    )]
    pub additional_properties: ::std::collections::HashMap<String, ::serde_json::Value>,
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize, PartialEq)]
#[doc = "Type of the metric."]
#[doc = ""]
pub enum Type {
    #[serde(rename = "counter")]
    Counter,
    #[serde(rename = "derive")]
    Derive,
    #[serde(rename = "gauge")]
    Gauge,
}
impl TryFrom<&str> for Type {
    type Error = String;
    fn try_from(value: &str) -> Result<Self, <Self as TryFrom<&str>>::Error> {
        match value {
            "counter" => Ok(Self::Counter),
            "derive" => Ok(Self::Derive),
            "gauge" => Ok(Self::Gauge),
            v => Err(format!("Unknown variant {v}")),
        }
    }
}