nominal_api/conjure/clients/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_client(name = "ContainerizedExtractorService")]
4pub trait ContainerizedExtractorService<
5    #[response_body]
6    I: Iterator<
7            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
8        >,
9> {
10    /// Registers a containerized extractor for a given set of containerized files.
11    #[endpoint(
12        method = POST,
13        path = "/extractors/v1/container",
14        name = "registerContainerizedExtractor",
15        accept = conjure_http::client::StdResponseDeserializer
16    )]
17    fn register_containerized_extractor(
18        &self,
19        #[auth]
20        auth_: &conjure_object::BearerToken,
21        #[body(serializer = conjure_http::client::StdRequestSerializer)]
22        request: &super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorRequest,
23    ) -> Result<
24        super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorResponse,
25        conjure_http::private::Error,
26    >;
27    /// Get a containerized extractor by its RID.
28    #[endpoint(
29        method = GET,
30        path = "/extractors/v1/container/{extractorRid}",
31        name = "getContainerizedExtractor",
32        accept = conjure_http::client::StdResponseDeserializer
33    )]
34    fn get_containerized_extractor(
35        &self,
36        #[auth]
37        auth_: &conjure_object::BearerToken,
38        #[path(
39            name = "extractorRid",
40            encoder = conjure_http::client::conjure::PlainEncoder
41        )]
42        extractor_rid: &conjure_object::ResourceIdentifier,
43    ) -> Result<
44        super::super::super::super::objects::ingest::api::ContainerizedExtractor,
45        conjure_http::private::Error,
46    >;
47    /// Search for containerized extractors based on query parameters.
48    #[endpoint(
49        method = POST,
50        path = "/extractors/v1/container/search",
51        name = "searchContainerizedExtractors",
52        accept = conjure_http::client::conjure::CollectionResponseDeserializer
53    )]
54    fn search_containerized_extractors(
55        &self,
56        #[auth]
57        auth_: &conjure_object::BearerToken,
58        #[body(serializer = conjure_http::client::StdRequestSerializer)]
59        request: &super::super::super::super::objects::ingest::api::SearchContainerizedExtractorsRequest,
60    ) -> Result<
61        Vec<super::super::super::super::objects::ingest::api::ContainerizedExtractor>,
62        conjure_http::private::Error,
63    >;
64    /// Update a containerized extractor. Only the fields that are set in the request will be updated.
65    #[endpoint(
66        method = PUT,
67        path = "/extractors/v1/container/{extractorRid}",
68        name = "updateContainerizedExtractor",
69        accept = conjure_http::client::StdResponseDeserializer
70    )]
71    fn update_containerized_extractor(
72        &self,
73        #[auth]
74        auth_: &conjure_object::BearerToken,
75        #[path(
76            name = "extractorRid",
77            encoder = conjure_http::client::conjure::PlainEncoder
78        )]
79        extractor_rid: &conjure_object::ResourceIdentifier,
80        #[body(serializer = conjure_http::client::StdRequestSerializer)]
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        accept = conjure_http::client::conjure::EmptyResponseDeserializer
92    )]
93    fn archive_containerized_extractor(
94        &self,
95        #[auth]
96        auth_: &conjure_object::BearerToken,
97        #[path(
98            name = "extractorRid",
99            encoder = conjure_http::client::conjure::PlainEncoder
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        accept = conjure_http::client::conjure::EmptyResponseDeserializer
109    )]
110    fn unarchive_containerized_extractor(
111        &self,
112        #[auth]
113        auth_: &conjure_object::BearerToken,
114        #[path(
115            name = "extractorRid",
116            encoder = conjure_http::client::conjure::PlainEncoder
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_client(name = "ContainerizedExtractorService")]
123pub trait AsyncContainerizedExtractorService<
124    #[response_body]
125    I: conjure_http::private::Stream<
126            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
127        >,
128> {
129    /// Registers a containerized extractor for a given set of containerized files.
130    #[endpoint(
131        method = POST,
132        path = "/extractors/v1/container",
133        name = "registerContainerizedExtractor",
134        accept = conjure_http::client::StdResponseDeserializer
135    )]
136    async fn register_containerized_extractor(
137        &self,
138        #[auth]
139        auth_: &conjure_object::BearerToken,
140        #[body(serializer = conjure_http::client::StdRequestSerializer)]
141        request: &super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorRequest,
142    ) -> Result<
143        super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorResponse,
144        conjure_http::private::Error,
145    >;
146    /// Get a containerized extractor by its RID.
147    #[endpoint(
148        method = GET,
149        path = "/extractors/v1/container/{extractorRid}",
150        name = "getContainerizedExtractor",
151        accept = conjure_http::client::StdResponseDeserializer
152    )]
153    async fn get_containerized_extractor(
154        &self,
155        #[auth]
156        auth_: &conjure_object::BearerToken,
157        #[path(
158            name = "extractorRid",
159            encoder = conjure_http::client::conjure::PlainEncoder
160        )]
161        extractor_rid: &conjure_object::ResourceIdentifier,
162    ) -> Result<
163        super::super::super::super::objects::ingest::api::ContainerizedExtractor,
164        conjure_http::private::Error,
165    >;
166    /// Search for containerized extractors based on query parameters.
167    #[endpoint(
168        method = POST,
169        path = "/extractors/v1/container/search",
170        name = "searchContainerizedExtractors",
171        accept = conjure_http::client::conjure::CollectionResponseDeserializer
172    )]
173    async fn search_containerized_extractors(
174        &self,
175        #[auth]
176        auth_: &conjure_object::BearerToken,
177        #[body(serializer = conjure_http::client::StdRequestSerializer)]
178        request: &super::super::super::super::objects::ingest::api::SearchContainerizedExtractorsRequest,
179    ) -> Result<
180        Vec<super::super::super::super::objects::ingest::api::ContainerizedExtractor>,
181        conjure_http::private::Error,
182    >;
183    /// Update a containerized extractor. Only the fields that are set in the request will be updated.
184    #[endpoint(
185        method = PUT,
186        path = "/extractors/v1/container/{extractorRid}",
187        name = "updateContainerizedExtractor",
188        accept = conjure_http::client::StdResponseDeserializer
189    )]
190    async fn update_containerized_extractor(
191        &self,
192        #[auth]
193        auth_: &conjure_object::BearerToken,
194        #[path(
195            name = "extractorRid",
196            encoder = conjure_http::client::conjure::PlainEncoder
197        )]
198        extractor_rid: &conjure_object::ResourceIdentifier,
199        #[body(serializer = conjure_http::client::StdRequestSerializer)]
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        accept = conjure_http::client::conjure::EmptyResponseDeserializer
211    )]
212    async fn archive_containerized_extractor(
213        &self,
214        #[auth]
215        auth_: &conjure_object::BearerToken,
216        #[path(
217            name = "extractorRid",
218            encoder = conjure_http::client::conjure::PlainEncoder
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        accept = conjure_http::client::conjure::EmptyResponseDeserializer
228    )]
229    async fn unarchive_containerized_extractor(
230        &self,
231        #[auth]
232        auth_: &conjure_object::BearerToken,
233        #[path(
234            name = "extractorRid",
235            encoder = conjure_http::client::conjure::PlainEncoder
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_client(name = "ContainerizedExtractorService", local)]
242pub trait LocalAsyncContainerizedExtractorService<
243    #[response_body]
244    I: conjure_http::private::Stream<
245            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
246        >,
247> {
248    /// Registers a containerized extractor for a given set of containerized files.
249    #[endpoint(
250        method = POST,
251        path = "/extractors/v1/container",
252        name = "registerContainerizedExtractor",
253        accept = conjure_http::client::StdResponseDeserializer
254    )]
255    async fn register_containerized_extractor(
256        &self,
257        #[auth]
258        auth_: &conjure_object::BearerToken,
259        #[body(serializer = conjure_http::client::StdRequestSerializer)]
260        request: &super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorRequest,
261    ) -> Result<
262        super::super::super::super::objects::ingest::api::RegisterContainerizedExtractorResponse,
263        conjure_http::private::Error,
264    >;
265    /// Get a containerized extractor by its RID.
266    #[endpoint(
267        method = GET,
268        path = "/extractors/v1/container/{extractorRid}",
269        name = "getContainerizedExtractor",
270        accept = conjure_http::client::StdResponseDeserializer
271    )]
272    async fn get_containerized_extractor(
273        &self,
274        #[auth]
275        auth_: &conjure_object::BearerToken,
276        #[path(
277            name = "extractorRid",
278            encoder = conjure_http::client::conjure::PlainEncoder
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        accept = conjure_http::client::conjure::CollectionResponseDeserializer
291    )]
292    async fn search_containerized_extractors(
293        &self,
294        #[auth]
295        auth_: &conjure_object::BearerToken,
296        #[body(serializer = conjure_http::client::StdRequestSerializer)]
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        accept = conjure_http::client::StdResponseDeserializer
308    )]
309    async fn update_containerized_extractor(
310        &self,
311        #[auth]
312        auth_: &conjure_object::BearerToken,
313        #[path(
314            name = "extractorRid",
315            encoder = conjure_http::client::conjure::PlainEncoder
316        )]
317        extractor_rid: &conjure_object::ResourceIdentifier,
318        #[body(serializer = conjure_http::client::StdRequestSerializer)]
319        request: &super::super::super::super::objects::ingest::api::UpdateContainerizedExtractorRequest,
320    ) -> Result<
321        super::super::super::super::objects::ingest::api::ContainerizedExtractor,
322        conjure_http::private::Error,
323    >;
324    /// Archive a containerized extractor.
325    #[endpoint(
326        method = PUT,
327        path = "/extractors/v1/container/{extractorRid}/archive",
328        name = "archiveContainerizedExtractor",
329        accept = conjure_http::client::conjure::EmptyResponseDeserializer
330    )]
331    async fn archive_containerized_extractor(
332        &self,
333        #[auth]
334        auth_: &conjure_object::BearerToken,
335        #[path(
336            name = "extractorRid",
337            encoder = conjure_http::client::conjure::PlainEncoder
338        )]
339        extractor_rid: &conjure_object::ResourceIdentifier,
340    ) -> Result<(), conjure_http::private::Error>;
341    /// Unarchive a containerized extractor.
342    #[endpoint(
343        method = PUT,
344        path = "/extractors/v1/container/{extractorRid}/unarchive",
345        name = "unarchiveContainerizedExtractor",
346        accept = conjure_http::client::conjure::EmptyResponseDeserializer
347    )]
348    async fn unarchive_containerized_extractor(
349        &self,
350        #[auth]
351        auth_: &conjure_object::BearerToken,
352        #[path(
353            name = "extractorRid",
354            encoder = conjure_http::client::conjure::PlainEncoder
355        )]
356        extractor_rid: &conjure_object::ResourceIdentifier,
357    ) -> Result<(), conjure_http::private::Error>;
358}
nominal_api/conjure/clients/ingest/api/containerized_extractor_service.rs

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