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

1use conjure_http::endpoint;
2/// The Containerized Extractor service provides functionality for creating, updating, and archiving containerized extractors.
3#[conjure_http::conjure_endpoints(
4    name = "ContainerizedExtractorService",
5    use_legacy_error_serialization
6)]
7pub trait ContainerizedExtractorService {
8    /// Registers a containerized extractor for a given set of containerized files.
9    #[endpoint(
10        method = POST,
11        path = "/extractors/v1/container",
12        name = "registerContainerizedExtractor",
13        produces = conjure_http::server::StdResponseSerializer
14    )]
15    fn register_containerized_extractor(
16        &self,
17        #[auth]
18        auth_: conjure_object::BearerToken,
19        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
20        request: super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorRequest,
21    ) -> Result<
22        super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorResponse,
23        conjure_http::private::Error,
24    >;
25    /// Get a containerized extractor by its RID.
26    #[endpoint(
27        method = GET,
28        path = "/extractors/v1/container/{extractorRid}",
29        name = "getContainerizedExtractor",
30        produces = conjure_http::server::StdResponseSerializer
31    )]
32    fn get_containerized_extractor(
33        &self,
34        #[auth]
35        auth_: conjure_object::BearerToken,
36        #[path(
37            name = "extractorRid",
38            decoder = conjure_http::server::conjure::FromPlainDecoder,
39            log_as = "extractorRid"
40        )]
41        extractor_rid: conjure_object::ResourceIdentifier,
42    ) -> Result<
43        super::super::super::super::objects::ingest::api::ContainerizedExtractor,
44        conjure_http::private::Error,
45    >;
46    /// Search for containerized extractors based on query parameters.
47    #[endpoint(
48        method = POST,
49        path = "/extractors/v1/container/search",
50        name = "searchContainerizedExtractors",
51        produces = conjure_http::server::conjure::CollectionResponseSerializer
52    )]
53    fn search_containerized_extractors(
54        &self,
55        #[auth]
56        auth_: conjure_object::BearerToken,
57        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
58        request: super::super::super::super::objects::ingest::api::SearchContainerizedExtractorsRequest,
59    ) -> Result<
60        Vec<super::super::super::super::objects::ingest::api::ContainerizedExtractor>,
61        conjure_http::private::Error,
62    >;
63    /// Update a containerized extractor. Only the fields that are set in the request will be updated.
64    #[endpoint(
65        method = PUT,
66        path = "/extractors/v1/container/{extractorRid}",
67        name = "updateContainerizedExtractor",
68        produces = conjure_http::server::StdResponseSerializer
69    )]
70    fn update_containerized_extractor(
71        &self,
72        #[auth]
73        auth_: conjure_object::BearerToken,
74        #[path(
75            name = "extractorRid",
76            decoder = conjure_http::server::conjure::FromPlainDecoder,
77            log_as = "extractorRid"
78        )]
79        extractor_rid: conjure_object::ResourceIdentifier,
80        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
81        request: super::super::super::super::objects::ingest::api::UpdateContainerizedExtractorRequest,
82    ) -> Result<
83        super::super::super::super::objects::ingest::api::ContainerizedExtractor,
84        conjure_http::private::Error,
85    >;
86    /// Archive a containerized extractor.
87    #[endpoint(
88        method = PUT,
89        path = "/extractors/v1/container/{extractorRid}/archive",
90        name = "archiveContainerizedExtractor"
91    )]
92    fn archive_containerized_extractor(
93        &self,
94        #[auth]
95        auth_: conjure_object::BearerToken,
96        #[path(
97            name = "extractorRid",
98            decoder = conjure_http::server::conjure::FromPlainDecoder,
99            log_as = "extractorRid"
100        )]
101        extractor_rid: conjure_object::ResourceIdentifier,
102    ) -> Result<(), conjure_http::private::Error>;
103    /// Unarchive a containerized extractor.
104    #[endpoint(
105        method = PUT,
106        path = "/extractors/v1/container/{extractorRid}/unarchive",
107        name = "unarchiveContainerizedExtractor"
108    )]
109    fn unarchive_containerized_extractor(
110        &self,
111        #[auth]
112        auth_: conjure_object::BearerToken,
113        #[path(
114            name = "extractorRid",
115            decoder = conjure_http::server::conjure::FromPlainDecoder,
116            log_as = "extractorRid"
117        )]
118        extractor_rid: conjure_object::ResourceIdentifier,
119    ) -> Result<(), conjure_http::private::Error>;
120}
121/// The Containerized Extractor service provides functionality for creating, updating, and archiving containerized extractors.
122#[conjure_http::conjure_endpoints(
123    name = "ContainerizedExtractorService",
124    use_legacy_error_serialization
125)]
126pub trait AsyncContainerizedExtractorService {
127    /// Registers a containerized extractor for a given set of containerized files.
128    #[endpoint(
129        method = POST,
130        path = "/extractors/v1/container",
131        name = "registerContainerizedExtractor",
132        produces = conjure_http::server::StdResponseSerializer
133    )]
134    async fn register_containerized_extractor(
135        &self,
136        #[auth]
137        auth_: conjure_object::BearerToken,
138        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
139        request: super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorRequest,
140    ) -> Result<
141        super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorResponse,
142        conjure_http::private::Error,
143    >;
144    /// Get a containerized extractor by its RID.
145    #[endpoint(
146        method = GET,
147        path = "/extractors/v1/container/{extractorRid}",
148        name = "getContainerizedExtractor",
149        produces = conjure_http::server::StdResponseSerializer
150    )]
151    async fn get_containerized_extractor(
152        &self,
153        #[auth]
154        auth_: conjure_object::BearerToken,
155        #[path(
156            name = "extractorRid",
157            decoder = conjure_http::server::conjure::FromPlainDecoder,
158            log_as = "extractorRid"
159        )]
160        extractor_rid: conjure_object::ResourceIdentifier,
161    ) -> Result<
162        super::super::super::super::objects::ingest::api::ContainerizedExtractor,
163        conjure_http::private::Error,
164    >;
165    /// Search for containerized extractors based on query parameters.
166    #[endpoint(
167        method = POST,
168        path = "/extractors/v1/container/search",
169        name = "searchContainerizedExtractors",
170        produces = conjure_http::server::conjure::CollectionResponseSerializer
171    )]
172    async fn search_containerized_extractors(
173        &self,
174        #[auth]
175        auth_: conjure_object::BearerToken,
176        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
177        request: super::super::super::super::objects::ingest::api::SearchContainerizedExtractorsRequest,
178    ) -> Result<
179        Vec<super::super::super::super::objects::ingest::api::ContainerizedExtractor>,
180        conjure_http::private::Error,
181    >;
182    /// Update a containerized extractor. Only the fields that are set in the request will be updated.
183    #[endpoint(
184        method = PUT,
185        path = "/extractors/v1/container/{extractorRid}",
186        name = "updateContainerizedExtractor",
187        produces = conjure_http::server::StdResponseSerializer
188    )]
189    async fn update_containerized_extractor(
190        &self,
191        #[auth]
192        auth_: conjure_object::BearerToken,
193        #[path(
194            name = "extractorRid",
195            decoder = conjure_http::server::conjure::FromPlainDecoder,
196            log_as = "extractorRid"
197        )]
198        extractor_rid: conjure_object::ResourceIdentifier,
199        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
200        request: super::super::super::super::objects::ingest::api::UpdateContainerizedExtractorRequest,
201    ) -> Result<
202        super::super::super::super::objects::ingest::api::ContainerizedExtractor,
203        conjure_http::private::Error,
204    >;
205    /// Archive a containerized extractor.
206    #[endpoint(
207        method = PUT,
208        path = "/extractors/v1/container/{extractorRid}/archive",
209        name = "archiveContainerizedExtractor"
210    )]
211    async fn archive_containerized_extractor(
212        &self,
213        #[auth]
214        auth_: conjure_object::BearerToken,
215        #[path(
216            name = "extractorRid",
217            decoder = conjure_http::server::conjure::FromPlainDecoder,
218            log_as = "extractorRid"
219        )]
220        extractor_rid: conjure_object::ResourceIdentifier,
221    ) -> Result<(), conjure_http::private::Error>;
222    /// Unarchive a containerized extractor.
223    #[endpoint(
224        method = PUT,
225        path = "/extractors/v1/container/{extractorRid}/unarchive",
226        name = "unarchiveContainerizedExtractor"
227    )]
228    async fn unarchive_containerized_extractor(
229        &self,
230        #[auth]
231        auth_: conjure_object::BearerToken,
232        #[path(
233            name = "extractorRid",
234            decoder = conjure_http::server::conjure::FromPlainDecoder,
235            log_as = "extractorRid"
236        )]
237        extractor_rid: conjure_object::ResourceIdentifier,
238    ) -> Result<(), conjure_http::private::Error>;
239}
240/// The Containerized Extractor service provides functionality for creating, updating, and archiving containerized extractors.
241#[conjure_http::conjure_endpoints(
242    name = "ContainerizedExtractorService",
243    use_legacy_error_serialization,
244    local
245)]
246pub trait LocalAsyncContainerizedExtractorService {
247    /// Registers a containerized extractor for a given set of containerized files.
248    #[endpoint(
249        method = POST,
250        path = "/extractors/v1/container",
251        name = "registerContainerizedExtractor",
252        produces = conjure_http::server::StdResponseSerializer
253    )]
254    async fn register_containerized_extractor(
255        &self,
256        #[auth]
257        auth_: conjure_object::BearerToken,
258        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
259        request: super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorRequest,
260    ) -> Result<
261        super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorResponse,
262        conjure_http::private::Error,
263    >;
264    /// Get a containerized extractor by its RID.
265    #[endpoint(
266        method = GET,
267        path = "/extractors/v1/container/{extractorRid}",
268        name = "getContainerizedExtractor",
269        produces = conjure_http::server::StdResponseSerializer
270    )]
271    async fn get_containerized_extractor(
272        &self,
273        #[auth]
274        auth_: conjure_object::BearerToken,
275        #[path(
276            name = "extractorRid",
277            decoder = conjure_http::server::conjure::FromPlainDecoder,
278            log_as = "extractorRid"
279        )]
280        extractor_rid: conjure_object::ResourceIdentifier,
281    ) -> Result<
282        super::super::super::super::objects::ingest::api::ContainerizedExtractor,
283        conjure_http::private::Error,
284    >;
285    /// Search for containerized extractors based on query parameters.
286    #[endpoint(
287        method = POST,
288        path = "/extractors/v1/container/search",
289        name = "searchContainerizedExtractors",
290        produces = conjure_http::server::conjure::CollectionResponseSerializer
291    )]
292    async fn search_containerized_extractors(
293        &self,
294        #[auth]
295        auth_: conjure_object::BearerToken,
296        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
297        request: super::super::super::super::objects::ingest::api::SearchContainerizedExtractorsRequest,
298    ) -> Result<
299        Vec<super::super::super::super::objects::ingest::api::ContainerizedExtractor>,
300        conjure_http::private::Error,
301    >;
302    /// Update a containerized extractor. Only the fields that are set in the request will be updated.
303    #[endpoint(
304        method = PUT,
305        path = "/extractors/v1/container/{extractorRid}",
306        name = "updateContainerizedExtractor",
307        produces = conjure_http::server::StdResponseSerializer
308    )]
309    async fn update_containerized_extractor(
310        &self,
311        #[auth]
312        auth_: conjure_object::BearerToken,
313        #[path(
314            name = "extractorRid",
315            decoder = conjure_http::server::conjure::FromPlainDecoder,
316            log_as = "extractorRid"
317        )]
318        extractor_rid: conjure_object::ResourceIdentifier,
319        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
320        request: super::super::super::super::objects::ingest::api::UpdateContainerizedExtractorRequest,
321    ) -> Result<
322        super::super::super::super::objects::ingest::api::ContainerizedExtractor,
323        conjure_http::private::Error,
324    >;
325    /// Archive a containerized extractor.
326    #[endpoint(
327        method = PUT,
328        path = "/extractors/v1/container/{extractorRid}/archive",
329        name = "archiveContainerizedExtractor"
330    )]
331    async fn archive_containerized_extractor(
332        &self,
333        #[auth]
334        auth_: conjure_object::BearerToken,
335        #[path(
336            name = "extractorRid",
337            decoder = conjure_http::server::conjure::FromPlainDecoder,
338            log_as = "extractorRid"
339        )]
340        extractor_rid: conjure_object::ResourceIdentifier,
341    ) -> Result<(), conjure_http::private::Error>;
342    /// Unarchive a containerized extractor.
343    #[endpoint(
344        method = PUT,
345        path = "/extractors/v1/container/{extractorRid}/unarchive",
346        name = "unarchiveContainerizedExtractor"
347    )]
348    async fn unarchive_containerized_extractor(
349        &self,
350        #[auth]
351        auth_: conjure_object::BearerToken,
352        #[path(
353            name = "extractorRid",
354            decoder = conjure_http::server::conjure::FromPlainDecoder,
355            log_as = "extractorRid"
356        )]
357        extractor_rid: conjure_object::ResourceIdentifier,
358    ) -> Result<(), conjure_http::private::Error>;
359}
nominal_api/conjure/endpoints/ingest/api/containerized_extractor_service.rs

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