nominal-api 0.1239.0

API bindings for the Nominal platform
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

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash
)]
#[serde(crate = "conjure_object::serde")]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct VideoFileIngestDetails {
    #[builder(default, into)]
    #[serde(
        rename = "fileDescription",
        skip_serializing_if = "Option::is_none",
        default
    )]
    file_description: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "fileProperties", skip_serializing_if = "Option::is_none", default)]
    file_properties: Option<
        std::collections::BTreeMap<
            super::super::super::api::PropertyName,
            super::super::super::api::PropertyValue,
        >,
    >,
    #[builder(default, into)]
    #[serde(rename = "fileLabels", skip_serializing_if = "Option::is_none", default)]
    file_labels: Option<std::collections::BTreeSet<super::super::super::api::Label>>,
}
impl VideoFileIngestDetails {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new() -> Self {
        Self::builder().build()
    }
    /// Description that is applied to the newly created video file.
    /// If not provided, defaults to the description used to create the video.
    #[inline]
    pub fn file_description(&self) -> Option<&str> {
        self.file_description.as_ref().map(|o| &**o)
    }
    /// Key-Value properties that are applied to the newly created video file.
    #[deprecated(
        note = "Field is ignored as video files do not have properties.\nWill be removed after 4/5/2025\n"
    )]
    #[inline]
    pub fn file_properties(
        &self,
    ) -> Option<
        &std::collections::BTreeMap<
            super::super::super::api::PropertyName,
            super::super::super::api::PropertyValue,
        >,
    > {
        self.file_properties.as_ref().map(|o| &*o)
    }
    /// Labels that are applied to the newly created video file.
    #[deprecated(
        note = "Field is ignored as video files do not have labels.\nWill be removed after 4/5/2025\n"
    )]
    #[inline]
    pub fn file_labels(
        &self,
    ) -> Option<&std::collections::BTreeSet<super::super::super::api::Label>> {
        self.file_labels.as_ref().map(|o| &*o)
    }
}