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