Skip to main content

nominal_api/conjure/endpoints/ingest/api/
ingest_job_service.rs

1use conjure_http::endpoint;
2/// Public API for querying ingest jobs.
3#[conjure_http::conjure_endpoints(
4    name = "IngestJobService",
5    use_legacy_error_serialization
6)]
7pub trait IngestJobService {
8    /// Returns a single ingest job by RID. Does not include the full ingest request details.
9    #[endpoint(
10        method = GET,
11        path = "/ingest/v1/ingest-job/{ingestJobRid}",
12        name = "getIngestJob",
13        produces = conjure_http::server::StdResponseSerializer
14    )]
15    fn get_ingest_job(
16        &self,
17        #[auth]
18        auth_: conjure_object::BearerToken,
19        #[path(
20            name = "ingestJobRid",
21            decoder = conjure_http::server::conjure::FromPlainDecoder,
22            log_as = "ingestJobRid",
23            safe
24        )]
25        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
26    ) -> Result<
27        super::super::super::super::objects::ingest::api::IngestJob,
28        conjure_http::private::Error,
29    >;
30    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
31    #[endpoint(
32        method = POST,
33        path = "/ingest/v1/ingest-jobs/search",
34        name = "searchIngestJobs",
35        produces = conjure_http::server::StdResponseSerializer
36    )]
37    fn search_ingest_jobs(
38        &self,
39        #[auth]
40        auth_: conjure_object::BearerToken,
41        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
42        request: super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
43    ) -> Result<
44        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
45        conjure_http::private::Error,
46    >;
47}
48/// Public API for querying ingest jobs.
49#[conjure_http::conjure_endpoints(
50    name = "IngestJobService",
51    use_legacy_error_serialization
52)]
53pub trait AsyncIngestJobService {
54    /// Returns a single ingest job by RID. Does not include the full ingest request details.
55    #[endpoint(
56        method = GET,
57        path = "/ingest/v1/ingest-job/{ingestJobRid}",
58        name = "getIngestJob",
59        produces = conjure_http::server::StdResponseSerializer
60    )]
61    async fn get_ingest_job(
62        &self,
63        #[auth]
64        auth_: conjure_object::BearerToken,
65        #[path(
66            name = "ingestJobRid",
67            decoder = conjure_http::server::conjure::FromPlainDecoder,
68            log_as = "ingestJobRid",
69            safe
70        )]
71        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
72    ) -> Result<
73        super::super::super::super::objects::ingest::api::IngestJob,
74        conjure_http::private::Error,
75    >;
76    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
77    #[endpoint(
78        method = POST,
79        path = "/ingest/v1/ingest-jobs/search",
80        name = "searchIngestJobs",
81        produces = conjure_http::server::StdResponseSerializer
82    )]
83    async fn search_ingest_jobs(
84        &self,
85        #[auth]
86        auth_: conjure_object::BearerToken,
87        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
88        request: super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
89    ) -> Result<
90        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
91        conjure_http::private::Error,
92    >;
93}
94/// Public API for querying ingest jobs.
95#[conjure_http::conjure_endpoints(
96    name = "IngestJobService",
97    use_legacy_error_serialization,
98    local
99)]
100pub trait LocalAsyncIngestJobService {
101    /// Returns a single ingest job by RID. Does not include the full ingest request details.
102    #[endpoint(
103        method = GET,
104        path = "/ingest/v1/ingest-job/{ingestJobRid}",
105        name = "getIngestJob",
106        produces = conjure_http::server::StdResponseSerializer
107    )]
108    async fn get_ingest_job(
109        &self,
110        #[auth]
111        auth_: conjure_object::BearerToken,
112        #[path(
113            name = "ingestJobRid",
114            decoder = conjure_http::server::conjure::FromPlainDecoder,
115            log_as = "ingestJobRid",
116            safe
117        )]
118        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
119    ) -> Result<
120        super::super::super::super::objects::ingest::api::IngestJob,
121        conjure_http::private::Error,
122    >;
123    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
124    #[endpoint(
125        method = POST,
126        path = "/ingest/v1/ingest-jobs/search",
127        name = "searchIngestJobs",
128        produces = conjure_http::server::StdResponseSerializer
129    )]
130    async fn search_ingest_jobs(
131        &self,
132        #[auth]
133        auth_: conjure_object::BearerToken,
134        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
135        request: super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
136    ) -> Result<
137        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
138        conjure_http::private::Error,
139    >;
140}