Skip to main content

nominal_api/conjure/objects/scout/video/api/
video.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 Video {
13    #[serde(rename = "rid")]
14    rid: super::super::super::super::api::rids::VideoRid,
15    #[builder(into)]
16    #[serde(rename = "title")]
17    title: String,
18    #[builder(default, into)]
19    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
20    description: Option<String>,
21    #[builder(default, set(item(type = super::super::super::super::api::Label)))]
22    #[serde(
23        rename = "labels",
24        skip_serializing_if = "std::collections::BTreeSet::is_empty",
25        default
26    )]
27    labels: std::collections::BTreeSet<super::super::super::super::api::Label>,
28    #[builder(
29        default,
30        map(
31            key(type = super::super::super::super::api::PropertyName),
32            value(type = super::super::super::super::api::PropertyValue)
33        )
34    )]
35    #[serde(
36        rename = "properties",
37        skip_serializing_if = "std::collections::BTreeMap::is_empty",
38        default
39    )]
40    properties: std::collections::BTreeMap<
41        super::super::super::super::api::PropertyName,
42        super::super::super::super::api::PropertyValue,
43    >,
44    #[serde(rename = "createdBy")]
45    created_by: conjure_object::ResourceIdentifier,
46    #[serde(rename = "createdAt")]
47    created_at: conjure_object::DateTime<conjure_object::Utc>,
48    #[serde(rename = "isArchived")]
49    is_archived: bool,
50    #[builder(
51        default,
52        custom(
53            type = impl
54            Into<Option<super::VideoOriginMetadata>>,
55            convert = |v|v.into().map(Box::new)
56        )
57    )]
58    #[serde(rename = "originMetadata", skip_serializing_if = "Option::is_none", default)]
59    origin_metadata: Option<Box<super::VideoOriginMetadata>>,
60    #[builder(
61        default,
62        custom(
63            type = impl
64            Into<Option<super::VideoAllSegmentsMetadata>>,
65            convert = |v|v.into().map(Box::new)
66        )
67    )]
68    #[serde(
69        rename = "allSegmentsMetadata",
70        skip_serializing_if = "Option::is_none",
71        default
72    )]
73    all_segments_metadata: Option<Box<super::VideoAllSegmentsMetadata>>,
74}
75impl Video {
76    #[inline]
77    pub fn rid(&self) -> &super::super::super::super::api::rids::VideoRid {
78        &self.rid
79    }
80    #[inline]
81    pub fn title(&self) -> &str {
82        &*self.title
83    }
84    #[inline]
85    pub fn description(&self) -> Option<&str> {
86        self.description.as_ref().map(|o| &**o)
87    }
88    #[inline]
89    pub fn labels(
90        &self,
91    ) -> &std::collections::BTreeSet<super::super::super::super::api::Label> {
92        &self.labels
93    }
94    #[inline]
95    pub fn properties(
96        &self,
97    ) -> &std::collections::BTreeMap<
98        super::super::super::super::api::PropertyName,
99        super::super::super::super::api::PropertyValue,
100    > {
101        &self.properties
102    }
103    #[inline]
104    pub fn created_by(&self) -> &conjure_object::ResourceIdentifier {
105        &self.created_by
106    }
107    #[inline]
108    pub fn created_at(&self) -> conjure_object::DateTime<conjure_object::Utc> {
109        self.created_at
110    }
111    #[inline]
112    pub fn is_archived(&self) -> bool {
113        self.is_archived
114    }
115    #[deprecated(
116        note = "deprecated in favor of per-file VideoFileOriginMetadata. Will be removed after April 15th."
117    )]
118    #[inline]
119    pub fn origin_metadata(&self) -> Option<&super::VideoOriginMetadata> {
120        self.origin_metadata.as_ref().map(|o| &**o)
121    }
122    #[inline]
123    pub fn all_segments_metadata(&self) -> Option<&super::VideoAllSegmentsMetadata> {
124        self.all_segments_metadata.as_ref().map(|o| &**o)
125    }
126}