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

use conjure_http::endpoint;
/// Creates and reports on ingest automations: server-side workflows that take an upload (one or
/// more files) through asset/dataset/data-scope/run creation, ingest, and channel availability. Backs
/// the upload wizard's "Quick look" mode; the frontend creates the accompanying workbook. All
/// endpoints validate that the target workspace is the sandbox workspace while the feature is
/// gated. Resources are created as the requesting user.
#[conjure_http::conjure_endpoints(
    name = "IngestAutomationService",
    use_legacy_error_serialization
)]
pub trait IngestAutomationService {
    /// Creates the automation and starts its workflow, returning immediately. Poll
    /// getIngestAutomation for progress. Throws WorkspaceNotSandbox outside the sandbox
    /// workspace while the feature is gated.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-automations",
        name = "createIngestAutomation",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn create_ingest_automation(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::CreateIngestAutomationRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestAutomation,
        conjure_http::private::Error,
    >;
    /// Returns the automation's current status and the RIDs of every resource created so far.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-automations/{rid}",
        name = "getIngestAutomation",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn get_ingest_automation(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "rid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            safe
        )]
        rid: super::super::super::super::objects::ingest::api::IngestAutomationRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestAutomation,
        conjure_http::private::Error,
    >;
}
/// Creates and reports on ingest automations: server-side workflows that take an upload (one or
/// more files) through asset/dataset/data-scope/run creation, ingest, and channel availability. Backs
/// the upload wizard's "Quick look" mode; the frontend creates the accompanying workbook. All
/// endpoints validate that the target workspace is the sandbox workspace while the feature is
/// gated. Resources are created as the requesting user.
#[conjure_http::conjure_endpoints(
    name = "IngestAutomationService",
    use_legacy_error_serialization
)]
pub trait AsyncIngestAutomationService {
    /// Creates the automation and starts its workflow, returning immediately. Poll
    /// getIngestAutomation for progress. Throws WorkspaceNotSandbox outside the sandbox
    /// workspace while the feature is gated.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-automations",
        name = "createIngestAutomation",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn create_ingest_automation(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::CreateIngestAutomationRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestAutomation,
        conjure_http::private::Error,
    >;
    /// Returns the automation's current status and the RIDs of every resource created so far.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-automations/{rid}",
        name = "getIngestAutomation",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_ingest_automation(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "rid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            safe
        )]
        rid: super::super::super::super::objects::ingest::api::IngestAutomationRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestAutomation,
        conjure_http::private::Error,
    >;
}
/// Creates and reports on ingest automations: server-side workflows that take an upload (one or
/// more files) through asset/dataset/data-scope/run creation, ingest, and channel availability. Backs
/// the upload wizard's "Quick look" mode; the frontend creates the accompanying workbook. All
/// endpoints validate that the target workspace is the sandbox workspace while the feature is
/// gated. Resources are created as the requesting user.
#[conjure_http::conjure_endpoints(
    name = "IngestAutomationService",
    use_legacy_error_serialization,
    local
)]
pub trait LocalAsyncIngestAutomationService {
    /// Creates the automation and starts its workflow, returning immediately. Poll
    /// getIngestAutomation for progress. Throws WorkspaceNotSandbox outside the sandbox
    /// workspace while the feature is gated.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-automations",
        name = "createIngestAutomation",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn create_ingest_automation(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::CreateIngestAutomationRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestAutomation,
        conjure_http::private::Error,
    >;
    /// Returns the automation's current status and the RIDs of every resource created so far.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-automations/{rid}",
        name = "getIngestAutomation",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_ingest_automation(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "rid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            safe
        )]
        rid: super::super::super::super::objects::ingest::api::IngestAutomationRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestAutomation,
        conjure_http::private::Error,
    >;
}