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

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