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

use conjure_http::endpoint;
/// Public API for querying ingest jobs.
#[conjure_http::conjure_endpoints(
    name = "IngestJobService",
    use_legacy_error_serialization
)]
pub trait IngestJobService {
    /// Returns a single ingest job by RID. Does not include the full ingest request details.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-job/{ingestJobRid}",
        name = "getIngestJob",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn get_ingest_job(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestJobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestJobRid",
            safe
        )]
        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestJob,
        conjure_http::private::Error,
    >;
    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/search",
        name = "searchIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn search_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
        conjure_http::private::Error,
    >;
}
/// Public API for querying ingest jobs.
#[conjure_http::conjure_endpoints(
    name = "IngestJobService",
    use_legacy_error_serialization
)]
pub trait AsyncIngestJobService {
    /// Returns a single ingest job by RID. Does not include the full ingest request details.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-job/{ingestJobRid}",
        name = "getIngestJob",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_ingest_job(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestJobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestJobRid",
            safe
        )]
        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestJob,
        conjure_http::private::Error,
    >;
    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/search",
        name = "searchIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn search_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
        conjure_http::private::Error,
    >;
}
/// Public API for querying ingest jobs.
#[conjure_http::conjure_endpoints(
    name = "IngestJobService",
    use_legacy_error_serialization,
    local
)]
pub trait LocalAsyncIngestJobService {
    /// Returns a single ingest job by RID. Does not include the full ingest request details.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-job/{ingestJobRid}",
        name = "getIngestJob",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_ingest_job(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestJobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestJobRid",
            safe
        )]
        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestJob,
        conjure_http::private::Error,
    >;
    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/search",
        name = "searchIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn search_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
        conjure_http::private::Error,
    >;
}