datadog-api-client 0.20.0

Rust client for the Datadog 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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
// Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2019-Present Datadog, Inc.
use serde::de::{Error, MapAccess, Visitor};
use serde::{Deserialize, Deserializer, Serialize};
use serde_with::skip_serializing_none;
use std::fmt::{self, Formatter};

/// A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying
/// key performance metrics, which enable you to monitor the health of your infrastructure.
#[non_exhaustive]
#[skip_serializing_none]
#[derive(Clone, Debug, PartialEq, Serialize)]
pub struct Dashboard {
    /// Identifier of the dashboard author.
    #[serde(rename = "author_handle")]
    pub author_handle: Option<String>,
    /// Name of the dashboard author.
    #[serde(
        rename = "author_name",
        default,
        with = "::serde_with::rust::double_option"
    )]
    pub author_name: Option<Option<String>>,
    /// Creation date of the dashboard.
    #[serde(rename = "created_at")]
    pub created_at: Option<chrono::DateTime<chrono::Utc>>,
    /// Description of the dashboard.
    #[serde(
        rename = "description",
        default,
        with = "::serde_with::rust::double_option"
    )]
    pub description: Option<Option<String>>,
    /// ID of the dashboard.
    #[serde(rename = "id")]
    pub id: Option<String>,
    /// Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
    ///
    /// This property is deprecated; please use the [Restriction Policies API](<https://docs.datadoghq.com/api/latest/restriction-policies/>) instead to manage write authorization for individual dashboards.
    #[deprecated]
    #[serde(rename = "is_read_only")]
    pub is_read_only: Option<bool>,
    /// Layout type of the dashboard.
    #[serde(rename = "layout_type")]
    pub layout_type: crate::datadogV1::model::DashboardLayoutType,
    /// Modification date of the dashboard.
    #[serde(rename = "modified_at")]
    pub modified_at: Option<chrono::DateTime<chrono::Utc>>,
    /// List of handles of users to notify when changes are made to this dashboard.
    #[serde(
        rename = "notify_list",
        default,
        with = "::serde_with::rust::double_option"
    )]
    pub notify_list: Option<Option<Vec<String>>>,
    /// Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'.
    /// If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',
    /// widgets should not have layouts.
    #[serde(rename = "reflow_type")]
    pub reflow_type: Option<crate::datadogV1::model::DashboardReflowType>,
    /// A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
    #[serde(rename = "restricted_roles")]
    pub restricted_roles: Option<Vec<String>>,
    /// List of team names representing ownership of a dashboard.
    #[serde(rename = "tags", default, with = "::serde_with::rust::double_option")]
    pub tags: Option<Option<Vec<String>>>,
    /// Array of template variables saved views.
    #[serde(
        rename = "template_variable_presets",
        default,
        with = "::serde_with::rust::double_option"
    )]
    pub template_variable_presets:
        Option<Option<Vec<crate::datadogV1::model::DashboardTemplateVariablePreset>>>,
    /// List of template variables for this dashboard.
    #[serde(
        rename = "template_variables",
        default,
        with = "::serde_with::rust::double_option"
    )]
    pub template_variables: Option<Option<Vec<crate::datadogV1::model::DashboardTemplateVariable>>>,
    /// Title of the dashboard.
    #[serde(rename = "title")]
    pub title: String,
    /// The URL of the dashboard.
    #[serde(rename = "url")]
    pub url: Option<String>,
    /// List of widgets to display on the dashboard.
    #[serde(rename = "widgets")]
    pub widgets: Vec<crate::datadogV1::model::Widget>,
    #[serde(flatten)]
    pub additional_properties: std::collections::BTreeMap<String, serde_json::Value>,
    #[serde(skip)]
    #[serde(default)]
    pub(crate) _unparsed: bool,
}

impl Dashboard {
    pub fn new(
        layout_type: crate::datadogV1::model::DashboardLayoutType,
        title: String,
        widgets: Vec<crate::datadogV1::model::Widget>,
    ) -> Dashboard {
        #[allow(deprecated)]
        Dashboard {
            author_handle: None,
            author_name: None,
            created_at: None,
            description: None,
            id: None,
            is_read_only: None,
            layout_type,
            modified_at: None,
            notify_list: None,
            reflow_type: None,
            restricted_roles: None,
            tags: None,
            template_variable_presets: None,
            template_variables: None,
            title,
            url: None,
            widgets,
            additional_properties: std::collections::BTreeMap::new(),
            _unparsed: false,
        }
    }

    #[allow(deprecated)]
    pub fn author_handle(mut self, value: String) -> Self {
        self.author_handle = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn author_name(mut self, value: Option<String>) -> Self {
        self.author_name = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn created_at(mut self, value: chrono::DateTime<chrono::Utc>) -> Self {
        self.created_at = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn description(mut self, value: Option<String>) -> Self {
        self.description = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn id(mut self, value: String) -> Self {
        self.id = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn is_read_only(mut self, value: bool) -> Self {
        self.is_read_only = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn modified_at(mut self, value: chrono::DateTime<chrono::Utc>) -> Self {
        self.modified_at = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn notify_list(mut self, value: Option<Vec<String>>) -> Self {
        self.notify_list = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn reflow_type(mut self, value: crate::datadogV1::model::DashboardReflowType) -> Self {
        self.reflow_type = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn restricted_roles(mut self, value: Vec<String>) -> Self {
        self.restricted_roles = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn tags(mut self, value: Option<Vec<String>>) -> Self {
        self.tags = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn template_variable_presets(
        mut self,
        value: Option<Vec<crate::datadogV1::model::DashboardTemplateVariablePreset>>,
    ) -> Self {
        self.template_variable_presets = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn template_variables(
        mut self,
        value: Option<Vec<crate::datadogV1::model::DashboardTemplateVariable>>,
    ) -> Self {
        self.template_variables = Some(value);
        self
    }

    #[allow(deprecated)]
    pub fn url(mut self, value: String) -> Self {
        self.url = Some(value);
        self
    }

    pub fn additional_properties(
        mut self,
        value: std::collections::BTreeMap<String, serde_json::Value>,
    ) -> Self {
        self.additional_properties = value;
        self
    }
}

impl<'de> Deserialize<'de> for Dashboard {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        struct DashboardVisitor;
        impl<'a> Visitor<'a> for DashboardVisitor {
            type Value = Dashboard;

            fn expecting(&self, f: &mut Formatter<'_>) -> fmt::Result {
                f.write_str("a mapping")
            }

            fn visit_map<M>(self, mut map: M) -> Result<Self::Value, M::Error>
            where
                M: MapAccess<'a>,
            {
                let mut author_handle: Option<String> = None;
                let mut author_name: Option<Option<String>> = None;
                let mut created_at: Option<chrono::DateTime<chrono::Utc>> = None;
                let mut description: Option<Option<String>> = None;
                let mut id: Option<String> = None;
                let mut is_read_only: Option<bool> = None;
                let mut layout_type: Option<crate::datadogV1::model::DashboardLayoutType> = None;
                let mut modified_at: Option<chrono::DateTime<chrono::Utc>> = None;
                let mut notify_list: Option<Option<Vec<String>>> = None;
                let mut reflow_type: Option<crate::datadogV1::model::DashboardReflowType> = None;
                let mut restricted_roles: Option<Vec<String>> = None;
                let mut tags: Option<Option<Vec<String>>> = None;
                let mut template_variable_presets: Option<
                    Option<Vec<crate::datadogV1::model::DashboardTemplateVariablePreset>>,
                > = None;
                let mut template_variables: Option<
                    Option<Vec<crate::datadogV1::model::DashboardTemplateVariable>>,
                > = None;
                let mut title: Option<String> = None;
                let mut url: Option<String> = None;
                let mut widgets: Option<Vec<crate::datadogV1::model::Widget>> = None;
                let mut additional_properties: std::collections::BTreeMap<
                    String,
                    serde_json::Value,
                > = std::collections::BTreeMap::new();
                let mut _unparsed = false;

                while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
                    match k.as_str() {
                        "author_handle" => {
                            if v.is_null() {
                                continue;
                            }
                            author_handle =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "author_name" => {
                            author_name =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "created_at" => {
                            if v.is_null() {
                                continue;
                            }
                            created_at = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "description" => {
                            description =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "id" => {
                            if v.is_null() {
                                continue;
                            }
                            id = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "is_read_only" => {
                            if v.is_null() {
                                continue;
                            }
                            is_read_only =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "layout_type" => {
                            layout_type =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                            if let Some(ref _layout_type) = layout_type {
                                match _layout_type {
                                    crate::datadogV1::model::DashboardLayoutType::UnparsedObject(_layout_type) => {
                                        _unparsed = true;
                                    },
                                    _ => {}
                                }
                            }
                        }
                        "modified_at" => {
                            if v.is_null() {
                                continue;
                            }
                            modified_at =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "notify_list" => {
                            notify_list =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "reflow_type" => {
                            if v.is_null() {
                                continue;
                            }
                            reflow_type =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                            if let Some(ref _reflow_type) = reflow_type {
                                match _reflow_type {
                                    crate::datadogV1::model::DashboardReflowType::UnparsedObject(_reflow_type) => {
                                        _unparsed = true;
                                    },
                                    _ => {}
                                }
                            }
                        }
                        "restricted_roles" => {
                            if v.is_null() {
                                continue;
                            }
                            restricted_roles =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "tags" => {
                            tags = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "template_variable_presets" => {
                            template_variable_presets =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "template_variables" => {
                            template_variables =
                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "title" => {
                            title = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "url" => {
                            if v.is_null() {
                                continue;
                            }
                            url = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        "widgets" => {
                            widgets = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                        }
                        &_ => {
                            if let Ok(value) = serde_json::from_value(v.clone()) {
                                additional_properties.insert(k, value);
                            }
                        }
                    }
                }
                let layout_type =
                    layout_type.ok_or_else(|| M::Error::missing_field("layout_type"))?;
                let title = title.ok_or_else(|| M::Error::missing_field("title"))?;
                let widgets = widgets.ok_or_else(|| M::Error::missing_field("widgets"))?;

                #[allow(deprecated)]
                let content = Dashboard {
                    author_handle,
                    author_name,
                    created_at,
                    description,
                    id,
                    is_read_only,
                    layout_type,
                    modified_at,
                    notify_list,
                    reflow_type,
                    restricted_roles,
                    tags,
                    template_variable_presets,
                    template_variables,
                    title,
                    url,
                    widgets,
                    additional_properties,
                    _unparsed,
                };

                Ok(content)
            }
        }

        deserializer.deserialize_any(DashboardVisitor)
    }
}