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

#[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 ValidatedFileInput {
    #[builder(
        custom(
            type = super::super::super::super::scout::catalog::S3Handle,
            convert = Box::new
        )
    )]
    #[serde(rename = "handle")]
    handle: Box<super::super::super::super::scout::catalog::S3Handle>,
    #[builder(into)]
    #[serde(rename = "fileName")]
    file_name: String,
    #[builder(into)]
    #[serde(rename = "envVar")]
    env_var: String,
}
impl ValidatedFileInput {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        handle: super::super::super::super::scout::catalog::S3Handle,
        file_name: impl Into<String>,
        env_var: impl Into<String>,
    ) -> Self {
        Self::builder().handle(handle).file_name(file_name).env_var(env_var).build()
    }
    /// Path to the input file in S3.
    #[inline]
    pub fn handle(&self) -> &super::super::super::super::scout::catalog::S3Handle {
        &*self.handle
    }
    /// Name of the file that will be placed on disk.
    #[inline]
    pub fn file_name(&self) -> &str {
        &*self.file_name
    }
    /// Environment variable that will store the path to the file.
    #[inline]
    pub fn env_var(&self) -> &str {
        &*self.env_var
    }
}