nominal-api-conjure 0.1291.0

Conjure HTTP 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

/// A single transform within an ingest job: one unit of extraction/processing work. Surfaces
/// status, type, and error details so callers can monitor and alert on ingest pipelines.
#[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 IngestTransform {
    #[serde(rename = "ingestTransformRid")]
    ingest_transform_rid: conjure_object::ResourceIdentifier,
    #[serde(rename = "ingestJobRid")]
    ingest_job_rid: conjure_object::ResourceIdentifier,
    #[serde(rename = "transformType")]
    transform_type: super::IngestTransformType,
    #[serde(rename = "status")]
    status: super::IngestTransformStatus,
    #[serde(rename = "createdAt")]
    created_at: conjure_object::DateTime<conjure_object::Utc>,
    #[serde(rename = "updatedAt")]
    updated_at: conjure_object::DateTime<conjure_object::Utc>,
    #[builder(default, into)]
    #[serde(rename = "errorMessage", skip_serializing_if = "Option::is_none", default)]
    error_message: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "finishedAt", skip_serializing_if = "Option::is_none", default)]
    finished_at: Option<conjure_object::DateTime<conjure_object::Utc>>,
}
impl IngestTransform {
    #[inline]
    pub fn ingest_transform_rid(&self) -> &conjure_object::ResourceIdentifier {
        &self.ingest_transform_rid
    }
    /// The ingest job this transform belongs to.
    #[inline]
    pub fn ingest_job_rid(&self) -> &conjure_object::ResourceIdentifier {
        &self.ingest_job_rid
    }
    #[inline]
    pub fn transform_type(&self) -> &super::IngestTransformType {
        &self.transform_type
    }
    #[inline]
    pub fn status(&self) -> &super::IngestTransformStatus {
        &self.status
    }
    #[inline]
    pub fn created_at(&self) -> conjure_object::DateTime<conjure_object::Utc> {
        self.created_at
    }
    #[inline]
    pub fn updated_at(&self) -> conjure_object::DateTime<conjure_object::Utc> {
        self.updated_at
    }
    /// The failure detail recorded when the transform terminated. Present only for FAILED
    /// transforms. May contain customer-derived content and is therefore not safe to log.
    #[inline]
    pub fn error_message(&self) -> Option<&str> {
        self.error_message.as_ref().map(|o| &**o)
    }
    /// The time the transform reached a terminal status (COMPLETED or FAILED). Absent while the
    /// transform is still QUEUED or IN_PROGRESS.
    #[inline]
    pub fn finished_at(&self) -> Option<conjure_object::DateTime<conjure_object::Utc>> {
        self.finished_at.as_ref().map(|o| *o)
    }
}