Skip to main content

nominal_api/conjure/objects/scout/chartdefinition/api/
video_viz_definition_v1.rs

1#[derive(
2    Debug,
3    Clone,
4    conjure_object::serde::Serialize,
5    conjure_object::serde::Deserialize,
6    PartialEq,
7    Eq,
8    PartialOrd,
9    Ord,
10    Hash
11)]
12#[serde(crate = "conjure_object::serde")]
13#[conjure_object::private::staged_builder::staged_builder]
14#[builder(crate = conjure_object::private::staged_builder, update, inline)]
15pub struct VideoVizDefinitionV1 {
16    #[builder(default, into)]
17    #[serde(rename = "events", skip_serializing_if = "Option::is_none", default)]
18    events: Option<Vec<super::Event>>,
19    #[builder(
20        default,
21        list(item(type = super::super::super::comparisonrun::api::ComparisonRunGroup))
22    )]
23    #[serde(
24        rename = "comparisonRunGroups",
25        skip_serializing_if = "Vec::is_empty",
26        default
27    )]
28    comparison_run_groups: Vec<
29        super::super::super::comparisonrun::api::ComparisonRunGroup,
30    >,
31    #[builder(default, into)]
32    #[serde(rename = "title", skip_serializing_if = "Option::is_none", default)]
33    title: Option<String>,
34    #[builder(default, into)]
35    #[serde(rename = "refName", skip_serializing_if = "Option::is_none", default)]
36    ref_name: Option<super::DataSourceRefName>,
37    #[builder(
38        default,
39        custom(
40            type = impl
41            Into<Option<super::VideoPanelDataSource>>,
42            convert = |v|v.into().map(Box::new)
43        )
44    )]
45    #[serde(rename = "datasource", skip_serializing_if = "Option::is_none", default)]
46    datasource: Option<Box<super::VideoPanelDataSource>>,
47}
48impl VideoVizDefinitionV1 {
49    /// Constructs a new instance of the type.
50    #[inline]
51    pub fn new() -> Self {
52        Self::builder().build()
53    }
54    #[deprecated(note = "Please use the workbook's eventRefs field instead.")]
55    #[inline]
56    pub fn events(&self) -> Option<&[super::Event]> {
57        self.events.as_ref().map(|o| &**o)
58    }
59    #[inline]
60    pub fn comparison_run_groups(
61        &self,
62    ) -> &[super::super::super::comparisonrun::api::ComparisonRunGroup] {
63        &*self.comparison_run_groups
64    }
65    #[inline]
66    pub fn title(&self) -> Option<&str> {
67        self.title.as_ref().map(|o| &**o)
68    }
69    #[deprecated(
70        note = "Datasource field will be preferred over refName field to support multiple assets.\n"
71    )]
72    #[inline]
73    pub fn ref_name(&self) -> Option<&super::DataSourceRefName> {
74        self.ref_name.as_ref().map(|o| &*o)
75    }
76    #[inline]
77    pub fn datasource(&self) -> Option<&super::VideoPanelDataSource> {
78        self.datasource.as_ref().map(|o| &**o)
79    }
80}