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

/// Metadata about a single file uploaded to S3 by yeeter.
/// Enriches the original manifest entry with S3 upload information.
#[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 UploadMetadata {
    #[builder(into)]
    #[serde(rename = "s3Key")]
    s3_key: String,
    #[builder(into)]
    #[serde(rename = "s3Bucket")]
    s3_bucket: String,
    #[builder(custom(type = super::ManifestOutput, convert = Box::new))]
    #[serde(rename = "manifestOutput")]
    manifest_output: Box<super::ManifestOutput>,
}
impl UploadMetadata {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        s3_key: impl Into<String>,
        s3_bucket: impl Into<String>,
        manifest_output: super::ManifestOutput,
    ) -> Self {
        Self::builder()
            .s3_key(s3_key)
            .s3_bucket(s3_bucket)
            .manifest_output(manifest_output)
            .build()
    }
    /// Full S3 key where the file was uploaded
    #[inline]
    pub fn s3_key(&self) -> &str {
        &*self.s3_key
    }
    /// S3 bucket name where the file was uploaded
    #[inline]
    pub fn s3_bucket(&self) -> &str {
        &*self.s3_bucket
    }
    /// The original manifest entry from the container's manifest.yaml
    #[inline]
    pub fn manifest_output(&self) -> &super::ManifestOutput {
        &*self.manifest_output
    }
}