nominal-api 0.1241.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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    conjure_object::private::DeriveWith
)]
#[serde(crate = "conjure_object::serde")]
#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct CreateVideoRequest {
    #[builder(into)]
    #[serde(rename = "title")]
    title: String,
    #[builder(default, into)]
    #[serde(rename = "description", skip_serializing_if = "Option::is_none", default)]
    description: Option<String>,
    #[builder(default, set(item(type = super::super::super::super::api::Label)))]
    #[serde(
        rename = "labels",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    labels: std::collections::BTreeSet<super::super::super::super::api::Label>,
    #[builder(
        default,
        map(
            key(type = super::super::super::super::api::PropertyName),
            value(type = super::super::super::super::api::PropertyValue)
        )
    )]
    #[serde(
        rename = "properties",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    properties: std::collections::BTreeMap<
        super::super::super::super::api::PropertyName,
        super::super::super::super::api::PropertyValue,
    >,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::VideoOriginMetadata>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "originMetadata", skip_serializing_if = "Option::is_none", default)]
    origin_metadata: Option<Box<super::VideoOriginMetadata>>,
    #[builder(default, into)]
    #[serde(rename = "workspace", skip_serializing_if = "Option::is_none", default)]
    workspace: Option<super::super::super::super::api::rids::WorkspaceRid>,
    #[builder(default, set(item(type = super::super::super::rids::api::MarkingRid)))]
    #[serde(
        rename = "markingRids",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    marking_rids: std::collections::BTreeSet<super::super::super::rids::api::MarkingRid>,
}
impl CreateVideoRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(title: impl Into<String>) -> Self {
        Self::builder().title(title).build()
    }
    #[inline]
    pub fn title(&self) -> &str {
        &*self.title
    }
    #[inline]
    pub fn description(&self) -> Option<&str> {
        self.description.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn labels(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::super::api::Label> {
        &self.labels
    }
    #[inline]
    pub fn properties(
        &self,
    ) -> &std::collections::BTreeMap<
        super::super::super::super::api::PropertyName,
        super::super::super::super::api::PropertyValue,
    > {
        &self.properties
    }
    #[deprecated(
        note = "deprecated in favor of per-file VideoFileOriginMetadata. Will be removed after April 15th."
    )]
    #[inline]
    pub fn origin_metadata(&self) -> Option<&super::VideoOriginMetadata> {
        self.origin_metadata.as_ref().map(|o| &**o)
    }
    /// The workspace in which to create the video. If not provided, the video will be created in
    /// the default workspace for the user's organization, if the default workspace for the
    /// organization is configured.
    #[inline]
    pub fn workspace(
        &self,
    ) -> Option<&super::super::super::super::api::rids::WorkspaceRid> {
        self.workspace.as_ref().map(|o| &*o)
    }
    /// The markings to apply to the created video.
    /// If not provided, the video will be visible to all users in the same workspace.
    #[inline]
    pub fn marking_rids(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::rids::api::MarkingRid> {
        &self.marking_rids
    }
}