nominal_api/conjure/clients/scout/datasource/connection/
connection_service.rs

1use conjure_http::endpoint;
2/// A Connection contains the relevant metadata and information to be used as a data source for runs.
3/// The Connection Service is responsible for creating, updating, and retrieving database connections.
4#[conjure_http::conjure_client(name = "ConnectionService")]
5pub trait ConnectionService<
6    #[response_body]
7    I: Iterator<
8            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
9        >,
10> {
11    /// Creates a new connection.
12    #[endpoint(
13        method = POST,
14        path = "/data-source/connection/v1/connections",
15        name = "createConnection",
16        accept = conjure_http::client::StdResponseDeserializer
17    )]
18    fn create_connection(
19        &self,
20        #[auth]
21        auth_: &conjure_object::BearerToken,
22        #[body(serializer = conjure_http::client::StdRequestSerializer)]
23        create_connection: &super::super::super::super::super::objects::scout::datasource::connection::api::CreateConnection,
24    ) -> Result<
25        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
26        conjure_http::private::Error,
27    >;
28    /// Updates an existing connection.
29    #[endpoint(
30        method = PUT,
31        path = "/data-source/connection/v1/connection/{rid}/details",
32        name = "updateConnection",
33        accept = conjure_http::client::StdResponseDeserializer
34    )]
35    fn update_connection(
36        &self,
37        #[auth]
38        auth_: &conjure_object::BearerToken,
39        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
40        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
41        #[body(serializer = conjure_http::client::StdRequestSerializer)]
42        request: &super::super::super::super::super::objects::scout::datasource::connection::api::UpdateConnectionRequest,
43    ) -> Result<
44        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
45        conjure_http::private::Error,
46    >;
47    /// Updates an existing connection status.
48    #[endpoint(
49        method = PUT,
50        path = "/data-source/connection/v1/connection/{rid}/status",
51        name = "updateConnectionStatus",
52        accept = conjure_http::client::conjure::EmptyResponseDeserializer
53    )]
54    fn update_connection_status(
55        &self,
56        #[auth]
57        auth_: &conjure_object::BearerToken,
58        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
59        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
60        #[body(serializer = conjure_http::client::StdRequestSerializer)]
61        request: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionStatus,
62    ) -> Result<(), conjure_http::private::Error>;
63    /// Adds available tag key/value pairs to the connection. If a tag name already exists, the values will be merged.
64    /// This is primarily an internal endpoint to update tags for external connections as they are periodically
65    /// scraped. This endpoint should only be called by clients for Visual crossing connections. Throws if called for
66    /// Nominal connections which have their tags automatically indexed in the underlying Database.
67    #[endpoint(
68        method = POST,
69        path = "/data-source/connection/v1/connection/{rid}/available-tags",
70        name = "addAvailableTags",
71        accept = conjure_http::client::StdResponseDeserializer
72    )]
73    fn add_available_tags(
74        &self,
75        #[auth]
76        auth_: &conjure_object::BearerToken,
77        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
78        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
79        #[body(serializer = conjure_http::client::StdRequestSerializer)]
80        tags: &std::collections::BTreeMap<
81            super::super::super::super::super::objects::api::TagName,
82            std::collections::BTreeSet<
83                super::super::super::super::super::objects::api::TagValue,
84            >,
85        >,
86    ) -> Result<
87        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
88        conjure_http::private::Error,
89    >;
90    /// Gets a connection by its RID.
91    #[endpoint(
92        method = GET,
93        path = "/data-source/connection/v1/connection/{rid}",
94        name = "getConnection",
95        accept = conjure_http::client::StdResponseDeserializer
96    )]
97    fn get_connection(
98        &self,
99        #[auth]
100        auth_: &conjure_object::BearerToken,
101        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
102        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
103    ) -> Result<
104        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
105        conjure_http::private::Error,
106    >;
107    /// Gets a set of connections by their RIDs.
108    #[endpoint(
109        method = POST,
110        path = "/data-source/connection/v1/connection/multiple",
111        name = "getConnections",
112        accept = conjure_http::client::conjure::CollectionResponseDeserializer
113    )]
114    fn get_connections(
115        &self,
116        #[auth]
117        auth_: &conjure_object::BearerToken,
118        #[body(serializer = conjure_http::client::StdRequestSerializer)]
119        rids: &std::collections::BTreeSet<
120            super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
121        >,
122    ) -> Result<
123        std::collections::BTreeSet<
124            super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
125        >,
126        conjure_http::private::Error,
127    >;
128    /// Lists all connections.
129    #[endpoint(
130        method = GET,
131        path = "/data-source/connection/v1/connections",
132        name = "listConnections",
133        accept = conjure_http::client::conjure::CollectionResponseDeserializer
134    )]
135    fn list_connections(
136        &self,
137        #[auth]
138        auth_: &conjure_object::BearerToken,
139        #[query(
140            name = "includeArchived",
141            encoder = conjure_http::client::conjure::PlainSeqEncoder
142        )]
143        include_archived: Option<bool>,
144        #[query(
145            name = "workspaces",
146            encoder = conjure_http::client::conjure::PlainSeqEncoder
147        )]
148        workspaces: &std::collections::BTreeSet<
149            super::super::super::super::super::objects::api::rids::WorkspaceRid,
150        >,
151    ) -> Result<
152        std::collections::BTreeSet<
153            super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
154        >,
155        conjure_http::private::Error,
156    >;
157    /// Lists connections with pagination. Returns connections ordered by creation time descending.
158    #[endpoint(
159        method = GET,
160        path = "/data-source/connection/v2/connections",
161        name = "listConnectionsV2",
162        accept = conjure_http::client::StdResponseDeserializer
163    )]
164    fn list_connections_v2(
165        &self,
166        #[auth]
167        auth_: &conjure_object::BearerToken,
168        #[query(
169            name = "includeArchived",
170            encoder = conjure_http::client::conjure::PlainSeqEncoder
171        )]
172        include_archived: Option<bool>,
173        #[query(
174            name = "workspaces",
175            encoder = conjure_http::client::conjure::PlainSeqEncoder
176        )]
177        workspaces: &std::collections::BTreeSet<
178            super::super::super::super::super::objects::api::rids::WorkspaceRid,
179        >,
180        #[query(
181            name = "pageSize",
182            encoder = conjure_http::client::conjure::PlainSeqEncoder
183        )]
184        page_size: Option<i32>,
185        #[query(
186            name = "nextPageToken",
187            encoder = conjure_http::client::conjure::PlainSeqEncoder
188        )]
189        next_page_token: Option<&super::super::super::super::super::objects::api::Token>,
190    ) -> Result<
191        super::super::super::super::super::objects::scout::datasource::connection::api::ListConnectionsResponse,
192        conjure_http::private::Error,
193    >;
194    /// Lists connections that reference the specified Nominal data sources, with pagination.
195    /// Only returns connections within the caller's organization.
196    #[endpoint(
197        method = GET,
198        path = "/data-source/connection/v2/connections/by-datasource",
199        name = "listConnectionsByNominalDataSource",
200        accept = conjure_http::client::StdResponseDeserializer
201    )]
202    fn list_connections_by_nominal_data_source(
203        &self,
204        #[auth]
205        auth_: &conjure_object::BearerToken,
206        #[query(
207            name = "nominalDataSourceRids",
208            encoder = conjure_http::client::conjure::PlainSeqEncoder
209        )]
210        nominal_data_source_rids: &std::collections::BTreeSet<
211            super::super::super::super::super::objects::api::rids::NominalDataSourceRid,
212        >,
213        #[query(
214            name = "workspaces",
215            encoder = conjure_http::client::conjure::PlainSeqEncoder
216        )]
217        workspaces: &std::collections::BTreeSet<
218            super::super::super::super::super::objects::api::rids::WorkspaceRid,
219        >,
220        #[query(
221            name = "pageSize",
222            encoder = conjure_http::client::conjure::PlainSeqEncoder
223        )]
224        page_size: Option<i32>,
225        #[query(
226            name = "nextPageToken",
227            encoder = conjure_http::client::conjure::PlainSeqEncoder
228        )]
229        next_page_token: Option<&super::super::super::super::super::objects::api::Token>,
230    ) -> Result<
231        super::super::super::super::super::objects::scout::datasource::connection::api::ListConnectionsResponse,
232        conjure_http::private::Error,
233    >;
234    /// Archives a connection, which simply tags the connection for a client to filter.
235    #[endpoint(
236        method = POST,
237        path = "/data-source/connection/v1/connections/{rid}/archive",
238        name = "archiveConnection",
239        accept = conjure_http::client::conjure::EmptyResponseDeserializer
240    )]
241    fn archive_connection(
242        &self,
243        #[auth]
244        auth_: &conjure_object::BearerToken,
245        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
246        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
247    ) -> Result<(), conjure_http::private::Error>;
248    /// Undoes the archiving of a connection.
249    #[endpoint(
250        method = POST,
251        path = "/data-source/connection/v1/connections/{rid}/unarchive",
252        name = "unarchiveConnection",
253        accept = conjure_http::client::conjure::EmptyResponseDeserializer
254    )]
255    fn unarchive_connection(
256        &self,
257        #[auth]
258        auth_: &conjure_object::BearerToken,
259        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
260        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
261    ) -> Result<(), conjure_http::private::Error>;
262}
263/// A Connection contains the relevant metadata and information to be used as a data source for runs.
264/// The Connection Service is responsible for creating, updating, and retrieving database connections.
265#[conjure_http::conjure_client(name = "ConnectionService")]
266pub trait AsyncConnectionService<
267    #[response_body]
268    I: conjure_http::private::Stream<
269            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
270        >,
271> {
272    /// Creates a new connection.
273    #[endpoint(
274        method = POST,
275        path = "/data-source/connection/v1/connections",
276        name = "createConnection",
277        accept = conjure_http::client::StdResponseDeserializer
278    )]
279    async fn create_connection(
280        &self,
281        #[auth]
282        auth_: &conjure_object::BearerToken,
283        #[body(serializer = conjure_http::client::StdRequestSerializer)]
284        create_connection: &super::super::super::super::super::objects::scout::datasource::connection::api::CreateConnection,
285    ) -> Result<
286        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
287        conjure_http::private::Error,
288    >;
289    /// Updates an existing connection.
290    #[endpoint(
291        method = PUT,
292        path = "/data-source/connection/v1/connection/{rid}/details",
293        name = "updateConnection",
294        accept = conjure_http::client::StdResponseDeserializer
295    )]
296    async fn update_connection(
297        &self,
298        #[auth]
299        auth_: &conjure_object::BearerToken,
300        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
301        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
302        #[body(serializer = conjure_http::client::StdRequestSerializer)]
303        request: &super::super::super::super::super::objects::scout::datasource::connection::api::UpdateConnectionRequest,
304    ) -> Result<
305        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
306        conjure_http::private::Error,
307    >;
308    /// Updates an existing connection status.
309    #[endpoint(
310        method = PUT,
311        path = "/data-source/connection/v1/connection/{rid}/status",
312        name = "updateConnectionStatus",
313        accept = conjure_http::client::conjure::EmptyResponseDeserializer
314    )]
315    async fn update_connection_status(
316        &self,
317        #[auth]
318        auth_: &conjure_object::BearerToken,
319        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
320        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
321        #[body(serializer = conjure_http::client::StdRequestSerializer)]
322        request: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionStatus,
323    ) -> Result<(), conjure_http::private::Error>;
324    /// Adds available tag key/value pairs to the connection. If a tag name already exists, the values will be merged.
325    /// This is primarily an internal endpoint to update tags for external connections as they are periodically
326    /// scraped. This endpoint should only be called by clients for Visual crossing connections. Throws if called for
327    /// Nominal connections which have their tags automatically indexed in the underlying Database.
328    #[endpoint(
329        method = POST,
330        path = "/data-source/connection/v1/connection/{rid}/available-tags",
331        name = "addAvailableTags",
332        accept = conjure_http::client::StdResponseDeserializer
333    )]
334    async fn add_available_tags(
335        &self,
336        #[auth]
337        auth_: &conjure_object::BearerToken,
338        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
339        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
340        #[body(serializer = conjure_http::client::StdRequestSerializer)]
341        tags: &std::collections::BTreeMap<
342            super::super::super::super::super::objects::api::TagName,
343            std::collections::BTreeSet<
344                super::super::super::super::super::objects::api::TagValue,
345            >,
346        >,
347    ) -> Result<
348        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
349        conjure_http::private::Error,
350    >;
351    /// Gets a connection by its RID.
352    #[endpoint(
353        method = GET,
354        path = "/data-source/connection/v1/connection/{rid}",
355        name = "getConnection",
356        accept = conjure_http::client::StdResponseDeserializer
357    )]
358    async fn get_connection(
359        &self,
360        #[auth]
361        auth_: &conjure_object::BearerToken,
362        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
363        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
364    ) -> Result<
365        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
366        conjure_http::private::Error,
367    >;
368    /// Gets a set of connections by their RIDs.
369    #[endpoint(
370        method = POST,
371        path = "/data-source/connection/v1/connection/multiple",
372        name = "getConnections",
373        accept = conjure_http::client::conjure::CollectionResponseDeserializer
374    )]
375    async fn get_connections(
376        &self,
377        #[auth]
378        auth_: &conjure_object::BearerToken,
379        #[body(serializer = conjure_http::client::StdRequestSerializer)]
380        rids: &std::collections::BTreeSet<
381            super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
382        >,
383    ) -> Result<
384        std::collections::BTreeSet<
385            super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
386        >,
387        conjure_http::private::Error,
388    >;
389    /// Lists all connections.
390    #[endpoint(
391        method = GET,
392        path = "/data-source/connection/v1/connections",
393        name = "listConnections",
394        accept = conjure_http::client::conjure::CollectionResponseDeserializer
395    )]
396    async fn list_connections(
397        &self,
398        #[auth]
399        auth_: &conjure_object::BearerToken,
400        #[query(
401            name = "includeArchived",
402            encoder = conjure_http::client::conjure::PlainSeqEncoder
403        )]
404        include_archived: Option<bool>,
405        #[query(
406            name = "workspaces",
407            encoder = conjure_http::client::conjure::PlainSeqEncoder
408        )]
409        workspaces: &std::collections::BTreeSet<
410            super::super::super::super::super::objects::api::rids::WorkspaceRid,
411        >,
412    ) -> Result<
413        std::collections::BTreeSet<
414            super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
415        >,
416        conjure_http::private::Error,
417    >;
418    /// Lists connections with pagination. Returns connections ordered by creation time descending.
419    #[endpoint(
420        method = GET,
421        path = "/data-source/connection/v2/connections",
422        name = "listConnectionsV2",
423        accept = conjure_http::client::StdResponseDeserializer
424    )]
425    async fn list_connections_v2(
426        &self,
427        #[auth]
428        auth_: &conjure_object::BearerToken,
429        #[query(
430            name = "includeArchived",
431            encoder = conjure_http::client::conjure::PlainSeqEncoder
432        )]
433        include_archived: Option<bool>,
434        #[query(
435            name = "workspaces",
436            encoder = conjure_http::client::conjure::PlainSeqEncoder
437        )]
438        workspaces: &std::collections::BTreeSet<
439            super::super::super::super::super::objects::api::rids::WorkspaceRid,
440        >,
441        #[query(
442            name = "pageSize",
443            encoder = conjure_http::client::conjure::PlainSeqEncoder
444        )]
445        page_size: Option<i32>,
446        #[query(
447            name = "nextPageToken",
448            encoder = conjure_http::client::conjure::PlainSeqEncoder
449        )]
450        next_page_token: Option<&super::super::super::super::super::objects::api::Token>,
451    ) -> Result<
452        super::super::super::super::super::objects::scout::datasource::connection::api::ListConnectionsResponse,
453        conjure_http::private::Error,
454    >;
455    /// Lists connections that reference the specified Nominal data sources, with pagination.
456    /// Only returns connections within the caller's organization.
457    #[endpoint(
458        method = GET,
459        path = "/data-source/connection/v2/connections/by-datasource",
460        name = "listConnectionsByNominalDataSource",
461        accept = conjure_http::client::StdResponseDeserializer
462    )]
463    async fn list_connections_by_nominal_data_source(
464        &self,
465        #[auth]
466        auth_: &conjure_object::BearerToken,
467        #[query(
468            name = "nominalDataSourceRids",
469            encoder = conjure_http::client::conjure::PlainSeqEncoder
470        )]
471        nominal_data_source_rids: &std::collections::BTreeSet<
472            super::super::super::super::super::objects::api::rids::NominalDataSourceRid,
473        >,
474        #[query(
475            name = "workspaces",
476            encoder = conjure_http::client::conjure::PlainSeqEncoder
477        )]
478        workspaces: &std::collections::BTreeSet<
479            super::super::super::super::super::objects::api::rids::WorkspaceRid,
480        >,
481        #[query(
482            name = "pageSize",
483            encoder = conjure_http::client::conjure::PlainSeqEncoder
484        )]
485        page_size: Option<i32>,
486        #[query(
487            name = "nextPageToken",
488            encoder = conjure_http::client::conjure::PlainSeqEncoder
489        )]
490        next_page_token: Option<&super::super::super::super::super::objects::api::Token>,
491    ) -> Result<
492        super::super::super::super::super::objects::scout::datasource::connection::api::ListConnectionsResponse,
493        conjure_http::private::Error,
494    >;
495    /// Archives a connection, which simply tags the connection for a client to filter.
496    #[endpoint(
497        method = POST,
498        path = "/data-source/connection/v1/connections/{rid}/archive",
499        name = "archiveConnection",
500        accept = conjure_http::client::conjure::EmptyResponseDeserializer
501    )]
502    async fn archive_connection(
503        &self,
504        #[auth]
505        auth_: &conjure_object::BearerToken,
506        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
507        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
508    ) -> Result<(), conjure_http::private::Error>;
509    /// Undoes the archiving of a connection.
510    #[endpoint(
511        method = POST,
512        path = "/data-source/connection/v1/connections/{rid}/unarchive",
513        name = "unarchiveConnection",
514        accept = conjure_http::client::conjure::EmptyResponseDeserializer
515    )]
516    async fn unarchive_connection(
517        &self,
518        #[auth]
519        auth_: &conjure_object::BearerToken,
520        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
521        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
522    ) -> Result<(), conjure_http::private::Error>;
523}
524/// A Connection contains the relevant metadata and information to be used as a data source for runs.
525/// The Connection Service is responsible for creating, updating, and retrieving database connections.
526#[conjure_http::conjure_client(name = "ConnectionService", local)]
527pub trait LocalAsyncConnectionService<
528    #[response_body]
529    I: conjure_http::private::Stream<
530            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
531        >,
532> {
533    /// Creates a new connection.
534    #[endpoint(
535        method = POST,
536        path = "/data-source/connection/v1/connections",
537        name = "createConnection",
538        accept = conjure_http::client::StdResponseDeserializer
539    )]
540    async fn create_connection(
541        &self,
542        #[auth]
543        auth_: &conjure_object::BearerToken,
544        #[body(serializer = conjure_http::client::StdRequestSerializer)]
545        create_connection: &super::super::super::super::super::objects::scout::datasource::connection::api::CreateConnection,
546    ) -> Result<
547        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
548        conjure_http::private::Error,
549    >;
550    /// Updates an existing connection.
551    #[endpoint(
552        method = PUT,
553        path = "/data-source/connection/v1/connection/{rid}/details",
554        name = "updateConnection",
555        accept = conjure_http::client::StdResponseDeserializer
556    )]
557    async fn update_connection(
558        &self,
559        #[auth]
560        auth_: &conjure_object::BearerToken,
561        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
562        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
563        #[body(serializer = conjure_http::client::StdRequestSerializer)]
564        request: &super::super::super::super::super::objects::scout::datasource::connection::api::UpdateConnectionRequest,
565    ) -> Result<
566        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
567        conjure_http::private::Error,
568    >;
569    /// Updates an existing connection status.
570    #[endpoint(
571        method = PUT,
572        path = "/data-source/connection/v1/connection/{rid}/status",
573        name = "updateConnectionStatus",
574        accept = conjure_http::client::conjure::EmptyResponseDeserializer
575    )]
576    async fn update_connection_status(
577        &self,
578        #[auth]
579        auth_: &conjure_object::BearerToken,
580        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
581        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
582        #[body(serializer = conjure_http::client::StdRequestSerializer)]
583        request: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionStatus,
584    ) -> Result<(), conjure_http::private::Error>;
585    /// Adds available tag key/value pairs to the connection. If a tag name already exists, the values will be merged.
586    /// This is primarily an internal endpoint to update tags for external connections as they are periodically
587    /// scraped. This endpoint should only be called by clients for Visual crossing connections. Throws if called for
588    /// Nominal connections which have their tags automatically indexed in the underlying Database.
589    #[endpoint(
590        method = POST,
591        path = "/data-source/connection/v1/connection/{rid}/available-tags",
592        name = "addAvailableTags",
593        accept = conjure_http::client::StdResponseDeserializer
594    )]
595    async fn add_available_tags(
596        &self,
597        #[auth]
598        auth_: &conjure_object::BearerToken,
599        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
600        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
601        #[body(serializer = conjure_http::client::StdRequestSerializer)]
602        tags: &std::collections::BTreeMap<
603            super::super::super::super::super::objects::api::TagName,
604            std::collections::BTreeSet<
605                super::super::super::super::super::objects::api::TagValue,
606            >,
607        >,
608    ) -> Result<
609        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
610        conjure_http::private::Error,
611    >;
612    /// Gets a connection by its RID.
613    #[endpoint(
614        method = GET,
615        path = "/data-source/connection/v1/connection/{rid}",
616        name = "getConnection",
617        accept = conjure_http::client::StdResponseDeserializer
618    )]
619    async fn get_connection(
620        &self,
621        #[auth]
622        auth_: &conjure_object::BearerToken,
623        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
624        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
625    ) -> Result<
626        super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
627        conjure_http::private::Error,
628    >;
629    /// Gets a set of connections by their RIDs.
630    #[endpoint(
631        method = POST,
632        path = "/data-source/connection/v1/connection/multiple",
633        name = "getConnections",
634        accept = conjure_http::client::conjure::CollectionResponseDeserializer
635    )]
636    async fn get_connections(
637        &self,
638        #[auth]
639        auth_: &conjure_object::BearerToken,
640        #[body(serializer = conjure_http::client::StdRequestSerializer)]
641        rids: &std::collections::BTreeSet<
642            super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
643        >,
644    ) -> Result<
645        std::collections::BTreeSet<
646            super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
647        >,
648        conjure_http::private::Error,
649    >;
650    /// Lists all connections.
651    #[endpoint(
652        method = GET,
653        path = "/data-source/connection/v1/connections",
654        name = "listConnections",
655        accept = conjure_http::client::conjure::CollectionResponseDeserializer
656    )]
657    async fn list_connections(
658        &self,
659        #[auth]
660        auth_: &conjure_object::BearerToken,
661        #[query(
662            name = "includeArchived",
663            encoder = conjure_http::client::conjure::PlainSeqEncoder
664        )]
665        include_archived: Option<bool>,
666        #[query(
667            name = "workspaces",
668            encoder = conjure_http::client::conjure::PlainSeqEncoder
669        )]
670        workspaces: &std::collections::BTreeSet<
671            super::super::super::super::super::objects::api::rids::WorkspaceRid,
672        >,
673    ) -> Result<
674        std::collections::BTreeSet<
675            super::super::super::super::super::objects::scout::datasource::connection::api::Connection,
676        >,
677        conjure_http::private::Error,
678    >;
679    /// Lists connections with pagination. Returns connections ordered by creation time descending.
680    #[endpoint(
681        method = GET,
682        path = "/data-source/connection/v2/connections",
683        name = "listConnectionsV2",
684        accept = conjure_http::client::StdResponseDeserializer
685    )]
686    async fn list_connections_v2(
687        &self,
688        #[auth]
689        auth_: &conjure_object::BearerToken,
690        #[query(
691            name = "includeArchived",
692            encoder = conjure_http::client::conjure::PlainSeqEncoder
693        )]
694        include_archived: Option<bool>,
695        #[query(
696            name = "workspaces",
697            encoder = conjure_http::client::conjure::PlainSeqEncoder
698        )]
699        workspaces: &std::collections::BTreeSet<
700            super::super::super::super::super::objects::api::rids::WorkspaceRid,
701        >,
702        #[query(
703            name = "pageSize",
704            encoder = conjure_http::client::conjure::PlainSeqEncoder
705        )]
706        page_size: Option<i32>,
707        #[query(
708            name = "nextPageToken",
709            encoder = conjure_http::client::conjure::PlainSeqEncoder
710        )]
711        next_page_token: Option<&super::super::super::super::super::objects::api::Token>,
712    ) -> Result<
713        super::super::super::super::super::objects::scout::datasource::connection::api::ListConnectionsResponse,
714        conjure_http::private::Error,
715    >;
716    /// Lists connections that reference the specified Nominal data sources, with pagination.
717    /// Only returns connections within the caller's organization.
718    #[endpoint(
719        method = GET,
720        path = "/data-source/connection/v2/connections/by-datasource",
721        name = "listConnectionsByNominalDataSource",
722        accept = conjure_http::client::StdResponseDeserializer
723    )]
724    async fn list_connections_by_nominal_data_source(
725        &self,
726        #[auth]
727        auth_: &conjure_object::BearerToken,
728        #[query(
729            name = "nominalDataSourceRids",
730            encoder = conjure_http::client::conjure::PlainSeqEncoder
731        )]
732        nominal_data_source_rids: &std::collections::BTreeSet<
733            super::super::super::super::super::objects::api::rids::NominalDataSourceRid,
734        >,
735        #[query(
736            name = "workspaces",
737            encoder = conjure_http::client::conjure::PlainSeqEncoder
738        )]
739        workspaces: &std::collections::BTreeSet<
740            super::super::super::super::super::objects::api::rids::WorkspaceRid,
741        >,
742        #[query(
743            name = "pageSize",
744            encoder = conjure_http::client::conjure::PlainSeqEncoder
745        )]
746        page_size: Option<i32>,
747        #[query(
748            name = "nextPageToken",
749            encoder = conjure_http::client::conjure::PlainSeqEncoder
750        )]
751        next_page_token: Option<&super::super::super::super::super::objects::api::Token>,
752    ) -> Result<
753        super::super::super::super::super::objects::scout::datasource::connection::api::ListConnectionsResponse,
754        conjure_http::private::Error,
755    >;
756    /// Archives a connection, which simply tags the connection for a client to filter.
757    #[endpoint(
758        method = POST,
759        path = "/data-source/connection/v1/connections/{rid}/archive",
760        name = "archiveConnection",
761        accept = conjure_http::client::conjure::EmptyResponseDeserializer
762    )]
763    async fn archive_connection(
764        &self,
765        #[auth]
766        auth_: &conjure_object::BearerToken,
767        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
768        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
769    ) -> Result<(), conjure_http::private::Error>;
770    /// Undoes the archiving of a connection.
771    #[endpoint(
772        method = POST,
773        path = "/data-source/connection/v1/connections/{rid}/unarchive",
774        name = "unarchiveConnection",
775        accept = conjure_http::client::conjure::EmptyResponseDeserializer
776    )]
777    async fn unarchive_connection(
778        &self,
779        #[auth]
780        auth_: &conjure_object::BearerToken,
781        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
782        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
783    ) -> Result<(), conjure_http::private::Error>;
784}
nominal_api/conjure/clients/scout/datasource/connection/connection_service.rs

nominal_api/conjure/clients/scout/datasource/connection/
connection_service.rs
