nominal_api/conjure/objects/scout/notebook/api/
notebook.rs

1#[derive(
2    Debug,
3    Clone,
4    conjure_object::serde::Serialize,
5    conjure_object::serde::Deserialize,
6    conjure_object::private::DeriveWith
7)]
8#[serde(crate = "conjure_object::serde")]
9#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
10#[conjure_object::private::staged_builder::staged_builder]
11#[builder(crate = conjure_object::private::staged_builder, update, inline)]
12pub struct Notebook {
13    #[serde(rename = "rid")]
14    rid: super::super::super::rids::api::NotebookRid,
15    #[serde(rename = "snapshotRid")]
16    snapshot_rid: super::super::super::rids::api::SnapshotRid,
17    #[serde(rename = "snapshotAuthorRid")]
18    snapshot_author_rid: super::super::super::rids::api::UserRid,
19    #[serde(rename = "snapshotCreatedAt")]
20    snapshot_created_at: conjure_object::DateTime<conjure_object::Utc>,
21    #[builder(custom(type = super::NotebookMetadata, convert = Box::new))]
22    #[serde(rename = "metadata")]
23    metadata: Box<super::NotebookMetadata>,
24    #[builder(into)]
25    #[serde(rename = "stateAsJson")]
26    state_as_json: String,
27    #[builder(default, into)]
28    #[serde(rename = "charts", skip_serializing_if = "Option::is_none", default)]
29    charts: Option<Vec<super::ChartWithOverlays>>,
30    #[builder(
31        custom(
32            type = super::super::super::layout::api::WorkbookLayout,
33            convert = Box::new
34        )
35    )]
36    #[serde(rename = "layout")]
37    layout: Box<super::super::super::layout::api::WorkbookLayout>,
38    #[builder(
39        default,
40        custom(
41            type = impl
42            Into<Option<super::super::super::workbookcommon::api::WorkbookContent>>,
43            convert = |v|v.into().map(Box::new)
44        )
45    )]
46    #[serde(rename = "content", skip_serializing_if = "Option::is_none", default)]
47    content: Option<Box<super::super::super::workbookcommon::api::WorkbookContent>>,
48    #[builder(
49        custom(
50            type = super::super::super::workbookcommon::api::UnifiedWorkbookContent,
51            convert = Box::new
52        )
53    )]
54    #[serde(rename = "contentV2")]
55    content_v2: Box<super::super::super::workbookcommon::api::UnifiedWorkbookContent>,
56    #[builder(
57        default,
58        set(item(type = super::super::super::workbookcommon::api::EventReference))
59    )]
60    #[serde(
61        rename = "eventRefs",
62        skip_serializing_if = "std::collections::BTreeSet::is_empty",
63        default
64    )]
65    event_refs: std::collections::BTreeSet<
66        super::super::super::workbookcommon::api::EventReference,
67    >,
68    #[builder(default, into)]
69    #[serde(rename = "checkAlertRefs", skip_serializing_if = "Option::is_none", default)]
70    check_alert_refs: Option<
71        std::collections::BTreeSet<
72            super::super::super::workbookcommon::api::CheckAlertReference,
73        >,
74    >,
75}
76impl Notebook {
77    #[inline]
78    pub fn rid(&self) -> &super::super::super::rids::api::NotebookRid {
79        &self.rid
80    }
81    #[inline]
82    pub fn snapshot_rid(&self) -> &super::super::super::rids::api::SnapshotRid {
83        &self.snapshot_rid
84    }
85    #[inline]
86    pub fn snapshot_author_rid(&self) -> &super::super::super::rids::api::UserRid {
87        &self.snapshot_author_rid
88    }
89    #[inline]
90    pub fn snapshot_created_at(&self) -> conjure_object::DateTime<conjure_object::Utc> {
91        self.snapshot_created_at
92    }
93    #[inline]
94    pub fn metadata(&self) -> &super::NotebookMetadata {
95        &*self.metadata
96    }
97    #[inline]
98    pub fn state_as_json(&self) -> &str {
99        &*self.state_as_json
100    }
101    #[deprecated(note = "charts are now stored in contentV2")]
102    #[inline]
103    pub fn charts(&self) -> Option<&[super::ChartWithOverlays]> {
104        self.charts.as_ref().map(|o| &**o)
105    }
106    #[inline]
107    pub fn layout(&self) -> &super::super::super::layout::api::WorkbookLayout {
108        &*self.layout
109    }
110    #[deprecated(note = "use contentV2 instead")]
111    #[inline]
112    pub fn content(
113        &self,
114    ) -> Option<&super::super::super::workbookcommon::api::WorkbookContent> {
115        self.content.as_ref().map(|o| &**o)
116    }
117    #[inline]
118    pub fn content_v2(
119        &self,
120    ) -> &super::super::super::workbookcommon::api::UnifiedWorkbookContent {
121        &*self.content_v2
122    }
123    #[inline]
124    pub fn event_refs(
125        &self,
126    ) -> &std::collections::BTreeSet<
127        super::super::super::workbookcommon::api::EventReference,
128    > {
129        &self.event_refs
130    }
131    #[deprecated(
132        note = "CheckAlerts are no longer supported and will be removed in the future.\nUse eventRefs to pin events to workbooks instead.\n"
133    )]
134    #[inline]
135    pub fn check_alert_refs(
136        &self,
137    ) -> Option<
138        &std::collections::BTreeSet<
139            super::super::super::workbookcommon::api::CheckAlertReference,
140        >,
141    > {
142        self.check_alert_refs.as_ref().map(|o| &*o)
143    }
144}
nominal_api/conjure/objects/scout/notebook/api/notebook.rs

nominal_api/conjure/objects/scout/notebook/api/
notebook.rs
