Skip to main content

nominal_api/conjure/objects/ingest/api/
video_file_ingest_details.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 VideoFileIngestDetails {
16    #[builder(default, into)]
17    #[serde(
18        rename = "fileDescription",
19        skip_serializing_if = "Option::is_none",
20        default
21    )]
22    file_description: Option<String>,
23    #[builder(default, into)]
24    #[serde(rename = "fileProperties", skip_serializing_if = "Option::is_none", default)]
25    file_properties: Option<std::collections::BTreeMap<String, String>>,
26    #[builder(default, into)]
27    #[serde(rename = "fileLabels", skip_serializing_if = "Option::is_none", default)]
28    file_labels: Option<std::collections::BTreeSet<String>>,
29}
30impl VideoFileIngestDetails {
31    /// Constructs a new instance of the type.
32    #[inline]
33    pub fn new() -> Self {
34        Self::builder().build()
35    }
36    /// Description that is applied to the newly created video file.
37    /// If not provided, defaults to the description used to create the video.
38    #[inline]
39    pub fn file_description(&self) -> Option<&str> {
40        self.file_description.as_ref().map(|o| &**o)
41    }
42    /// Key-Value properties that are applied to the newly created video file.
43    #[deprecated(
44        note = "Field is ignored as video files do not have properties.\nWill be removed after 4/5/2025\n"
45    )]
46    #[inline]
47    pub fn file_properties(
48        &self,
49    ) -> Option<&std::collections::BTreeMap<String, String>> {
50        self.file_properties.as_ref().map(|o| &*o)
51    }
52    /// Labels that are applied to the newly created video file.
53    #[deprecated(
54        note = "Field is ignored as video files do not have labels.\nWill be removed after 4/5/2025\n"
55    )]
56    #[inline]
57    pub fn file_labels(&self) -> Option<&std::collections::BTreeSet<String>> {
58        self.file_labels.as_ref().map(|o| &*o)
59    }
60}