nominal-api 0.1240.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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

#[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 IngestRunRequest {
    #[builder(default, into)]
    #[serde(rename = "rid", skip_serializing_if = "Option::is_none", default)]
    rid: Option<conjure_object::ResourceIdentifier>,
    #[builder(into)]
    #[serde(rename = "title")]
    title: String,
    #[builder(into)]
    #[serde(rename = "description")]
    description: String,
    #[builder(custom(type = super::UtcTimestamp, convert = Box::new))]
    #[serde(rename = "startTime")]
    start_time: Box<super::UtcTimestamp>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::UtcTimestamp>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "endTime", skip_serializing_if = "Option::is_none", default)]
    end_time: Option<Box<super::UtcTimestamp>>,
    #[builder(
        default,
        map(
            key(type = super::super::super::api::PropertyName),
            value(type = super::super::super::api::PropertyValue)
        )
    )]
    #[serde(
        rename = "properties",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    properties: std::collections::BTreeMap<
        super::super::super::api::PropertyName,
        super::super::super::api::PropertyValue,
    >,
    #[builder(default, set(item(type = super::super::super::api::Label)))]
    #[serde(
        rename = "labels",
        skip_serializing_if = "std::collections::BTreeSet::is_empty",
        default
    )]
    labels: std::collections::BTreeSet<super::super::super::api::Label>,
    #[builder(default, into)]
    #[serde(rename = "runPrefix", skip_serializing_if = "Option::is_none", default)]
    run_prefix: Option<String>,
    #[builder(
        default,
        map(
            key(type = super::DataSourceRefName),
            value(type = super::IngestRunDataSource)
        )
    )]
    #[serde(
        rename = "dataSources",
        skip_serializing_if = "std::collections::BTreeMap::is_empty",
        default
    )]
    data_sources: std::collections::BTreeMap<
        super::DataSourceRefName,
        super::IngestRunDataSource,
    >,
    #[builder(default, into)]
    #[serde(rename = "workspace", skip_serializing_if = "Option::is_none", default)]
    workspace: Option<super::super::super::api::rids::WorkspaceRid>,
}
impl IngestRunRequest {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        title: impl Into<String>,
        description: impl Into<String>,
        start_time: super::UtcTimestamp,
    ) -> Self {
        Self::builder()
            .title(title)
            .description(description)
            .start_time(start_time)
            .build()
    }
    /// If a run with the same rid already exists, the run will be updated.
    #[inline]
    pub fn rid(&self) -> Option<&conjure_object::ResourceIdentifier> {
        self.rid.as_ref().map(|o| &*o)
    }
    #[inline]
    pub fn title(&self) -> &str {
        &*self.title
    }
    #[inline]
    pub fn description(&self) -> &str {
        &*self.description
    }
    #[inline]
    pub fn start_time(&self) -> &super::UtcTimestamp {
        &*self.start_time
    }
    #[inline]
    pub fn end_time(&self) -> Option<&super::UtcTimestamp> {
        self.end_time.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn properties(
        &self,
    ) -> &std::collections::BTreeMap<
        super::super::super::api::PropertyName,
        super::super::super::api::PropertyValue,
    > {
        &self.properties
    }
    #[inline]
    pub fn labels(
        &self,
    ) -> &std::collections::BTreeSet<super::super::super::api::Label> {
        &self.labels
    }
    /// for example, SIM, HTL, FLT
    #[inline]
    pub fn run_prefix(&self) -> Option<&str> {
        self.run_prefix.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn data_sources(
        &self,
    ) -> &std::collections::BTreeMap<
        super::DataSourceRefName,
        super::IngestRunDataSource,
    > {
        &self.data_sources
    }
    /// The workspace in which to create the dataset. If not provided, the dataset 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::api::rids::WorkspaceRid> {
        self.workspace.as_ref().map(|o| &*o)
    }
}