nominal-api-conjure 0.1433.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
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

/// A server-side workflow that carries one upload (one or more CSV files) through resource
/// creation, ingest, and channel availability. Started by the upload wizard's "Quick look" mode; the client
/// polls getIngestAutomation to drive its progress checklist, and the frontend creates the
/// accompanying workbook itself (workbook semantics live in the frontend server — this
/// service deliberately has no notion of workbooks). The workflow keeps running if the
/// client disconnects — every created resource RID is recorded here so a returning client
/// can pick up where it left off.
#[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 IngestAutomation {
    #[serde(rename = "rid")]
    rid: super::IngestAutomationRid,
    #[serde(rename = "status")]
    status: super::IngestAutomationStatus,
    #[serde(rename = "workspaceRid")]
    workspace_rid: super::super::super::api::rids::WorkspaceRid,
    #[serde(rename = "createdByRid")]
    created_by_rid: super::super::super::scout::rids::api::UserRid,
    #[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 = "assetRid", skip_serializing_if = "Option::is_none", default)]
    asset_rid: Option<super::super::super::scout::rids::api::AssetRid>,
    #[builder(default, into)]
    #[serde(rename = "datasetRid", skip_serializing_if = "Option::is_none", default)]
    dataset_rid: Option<super::super::super::api::rids::DatasetRid>,
    #[builder(default, into)]
    #[serde(rename = "runRid", skip_serializing_if = "Option::is_none", default)]
    run_rid: Option<super::super::super::scout::run::api::RunRid>,
    #[builder(default, into)]
    #[serde(rename = "ingestJobRid", skip_serializing_if = "Option::is_none", default)]
    ingest_job_rid: Option<super::IngestJobRid>,
    #[builder(default, into)]
    #[serde(rename = "failedStep", skip_serializing_if = "Option::is_none", default)]
    failed_step: Option<super::IngestAutomationStep>,
    #[builder(default, into)]
    #[serde(rename = "errorMessage", skip_serializing_if = "Option::is_none", default)]
    error_message: Option<String>,
}
impl IngestAutomation {
    #[inline]
    pub fn rid(&self) -> &super::IngestAutomationRid {
        &self.rid
    }
    #[inline]
    pub fn status(&self) -> &super::IngestAutomationStatus {
        &self.status
    }
    #[inline]
    pub fn workspace_rid(&self) -> &super::super::super::api::rids::WorkspaceRid {
        &self.workspace_rid
    }
    #[inline]
    pub fn created_by_rid(&self) -> &super::super::super::scout::rids::api::UserRid {
        &self.created_by_rid
    }
    #[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
    }
    /// Present once CREATING_RESOURCES has created the asset.
    #[inline]
    pub fn asset_rid(&self) -> Option<&super::super::super::scout::rids::api::AssetRid> {
        self.asset_rid.as_ref().map(|o| &*o)
    }
    /// Present once CREATING_RESOURCES has created the dataset.
    #[inline]
    pub fn dataset_rid(&self) -> Option<&super::super::super::api::rids::DatasetRid> {
        self.dataset_rid.as_ref().map(|o| &*o)
    }
    /// Present once CREATING_RESOURCES has created the run.
    #[inline]
    pub fn run_rid(&self) -> Option<&super::super::super::scout::run::api::RunRid> {
        self.run_rid.as_ref().map(|o| &*o)
    }
    /// Present once INGESTING has submitted the ingest job.
    #[inline]
    pub fn ingest_job_rid(&self) -> Option<&super::IngestJobRid> {
        self.ingest_job_rid.as_ref().map(|o| &*o)
    }
    /// The step that terminated the automation. Present only for FAILED automations.
    #[inline]
    pub fn failed_step(&self) -> Option<&super::IngestAutomationStep> {
        self.failed_step.as_ref().map(|o| &*o)
    }
    /// The failure detail recorded when the automation terminated. Present only for FAILED
    /// automations. 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)
    }
}