nominal_api/conjure/clients/scout/catalog/
catalog_service.rs

1use conjure_http::endpoint;
2/// The Catalog Service provides the ability to query for information about Datasets that are stored in
3/// the Nominal platform. A Dataset is the Nominal representation of data that has been uploaded to Nominal via
4/// a file, primarily CSV.
5#[conjure_http::conjure_client(name = "CatalogService")]
6pub trait CatalogService<
7    #[response_body]
8    I: Iterator<
9            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
10        >,
11> {
12    #[endpoint(
13        method = GET,
14        path = "/catalog/v1/datasets/{datasetUuid}",
15        name = "getEnrichedDataset",
16        accept = conjure_http::client::StdResponseDeserializer
17    )]
18    fn get_enriched_dataset(
19        &self,
20        #[auth]
21        auth_: &conjure_object::BearerToken,
22        #[path(
23            name = "datasetUuid",
24            encoder = conjure_http::client::conjure::PlainEncoder
25        )]
26        dataset_uuid: conjure_object::Uuid,
27    ) -> Result<
28        super::super::super::super::objects::scout::catalog::EnrichedDataset,
29        conjure_http::private::Error,
30    >;
31    #[endpoint(
32        method = POST,
33        path = "/catalog/v1/datasets/multiple",
34        name = "getEnrichedDatasets",
35        accept = conjure_http::client::conjure::CollectionResponseDeserializer
36    )]
37    fn get_enriched_datasets(
38        &self,
39        #[auth]
40        auth_: &conjure_object::BearerToken,
41        #[body(serializer = conjure_http::client::StdRequestSerializer)]
42        get_datasets_request: &super::super::super::super::objects::scout::catalog::GetDatasetsRequest,
43    ) -> Result<
44        std::collections::BTreeSet<
45            super::super::super::super::objects::scout::catalog::EnrichedDataset,
46        >,
47        conjure_http::private::Error,
48    >;
49    #[endpoint(
50        method = GET,
51        path = "/catalog/v1/datasets-simple/{datasetUuid}",
52        name = "getDataset",
53        accept = conjure_http::client::StdResponseDeserializer
54    )]
55    fn get_dataset(
56        &self,
57        #[auth]
58        auth_: &conjure_object::BearerToken,
59        #[path(
60            name = "datasetUuid",
61            encoder = conjure_http::client::conjure::PlainEncoder
62        )]
63        dataset_uuid: conjure_object::Uuid,
64    ) -> Result<
65        super::super::super::super::objects::scout::catalog::Dataset,
66        conjure_http::private::Error,
67    >;
68    #[endpoint(
69        method = POST,
70        path = "/catalog/v1/datasets-simple/multiple",
71        name = "getDatasets",
72        accept = conjure_http::client::conjure::CollectionResponseDeserializer
73    )]
74    fn get_datasets(
75        &self,
76        #[auth]
77        auth_: &conjure_object::BearerToken,
78        #[body(serializer = conjure_http::client::StdRequestSerializer)]
79        get_datasets_request: &super::super::super::super::objects::scout::catalog::GetDatasetsRequest,
80    ) -> Result<
81        std::collections::BTreeSet<
82            super::super::super::super::objects::scout::catalog::Dataset,
83        >,
84        conjure_http::private::Error,
85    >;
86    /// Gets the subset of dataset RIDs that currently have external connection config attached.
87    #[endpoint(
88        method = POST,
89        path = "/catalog/v1/datasets-simple/external-config",
90        name = "getDatasetsWithExternalConnectionConfig",
91        accept = conjure_http::client::conjure::CollectionResponseDeserializer
92    )]
93    fn get_datasets_with_external_connection_config(
94        &self,
95        #[auth]
96        auth_: &conjure_object::BearerToken,
97        #[body(serializer = conjure_http::client::StdRequestSerializer)]
98        get_datasets_request: &super::super::super::super::objects::scout::catalog::GetDatasetsRequest,
99    ) -> Result<
100        std::collections::BTreeSet<
101            super::super::super::super::objects::api::rids::DatasetRid,
102        >,
103        conjure_http::private::Error,
104    >;
105    /// Registers or updates external connection configuration for an existing dataset.
106    #[endpoint(
107        method = POST,
108        path = "/catalog/v1/datasets/external-config",
109        name = "registerExternalConnectionConfig",
110        accept = conjure_http::client::StdResponseDeserializer
111    )]
112    fn register_external_connection_config(
113        &self,
114        #[auth]
115        auth_: &conjure_object::BearerToken,
116        #[body(serializer = conjure_http::client::StdRequestSerializer)]
117        request: &super::super::super::super::objects::scout::catalog::RegisterExternalConnectionConfigRequest,
118    ) -> Result<
119        super::super::super::super::objects::scout::catalog::EnrichedDataset,
120        conjure_http::private::Error,
121    >;
122    #[endpoint(
123        method = GET,
124        path = "/catalog/v1/dataset/{datasetRid}/file/{fileId}",
125        name = "getDatasetFile",
126        accept = conjure_http::client::StdResponseDeserializer
127    )]
128    fn get_dataset_file(
129        &self,
130        #[auth]
131        auth_: &conjure_object::BearerToken,
132        #[path(
133            name = "datasetRid",
134            encoder = conjure_http::client::conjure::PlainEncoder
135        )]
136        dataset_rid: &conjure_object::ResourceIdentifier,
137        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
138        file_id: super::super::super::super::objects::datasource::DatasetFileId,
139    ) -> Result<
140        super::super::super::super::objects::scout::catalog::DatasetFile,
141        conjure_http::private::Error,
142    >;
143    /// Returns dataset files for the given file IDs within a single dataset. Only returns files that
144    /// exist and belong to the specified dataset. Useful for checking ingestion status of many files at once.
145    #[endpoint(
146        method = POST,
147        path = "/catalog/v1/dataset-files/batchGet",
148        name = "batchGetDatasetFiles",
149        accept = conjure_http::client::conjure::CollectionResponseDeserializer
150    )]
151    fn batch_get_dataset_files(
152        &self,
153        #[auth]
154        auth_: &conjure_object::BearerToken,
155        #[body(serializer = conjure_http::client::StdRequestSerializer)]
156        request: &super::super::super::super::objects::scout::catalog::BatchGetDatasetFilesRequest,
157    ) -> Result<
158        std::collections::BTreeMap<
159            super::super::super::super::objects::datasource::DatasetFileId,
160            super::super::super::super::objects::scout::catalog::DatasetFile,
161        >,
162        conjure_http::private::Error,
163    >;
164    #[endpoint(
165        method = GET,
166        path = "/catalog/v1/ingest-job/{ingestJobRid}/files",
167        name = "getDatasetFilesForJob",
168        accept = conjure_http::client::StdResponseDeserializer
169    )]
170    fn get_dataset_files_for_job(
171        &self,
172        #[auth]
173        auth_: &conjure_object::BearerToken,
174        #[path(
175            name = "ingestJobRid",
176            encoder = conjure_http::client::conjure::PlainEncoder
177        )]
178        ingest_job_rid: &conjure_object::ResourceIdentifier,
179        #[query(
180            name = "nextPageToken",
181            encoder = conjure_http::client::conjure::PlainSeqEncoder
182        )]
183        next_page_token: Option<&super::super::super::super::objects::api::Token>,
184    ) -> Result<
185        super::super::super::super::objects::scout::catalog::DatasetFilesPage,
186        conjure_http::private::Error,
187    >;
188    #[endpoint(
189        method = POST,
190        path = "/catalog/v1/search-datasets-v2",
191        name = "searchDatasets",
192        accept = conjure_http::client::StdResponseDeserializer
193    )]
194    fn search_datasets(
195        &self,
196        #[auth]
197        auth_: &conjure_object::BearerToken,
198        #[body(serializer = conjure_http::client::StdRequestSerializer)]
199        request: &super::super::super::super::objects::scout::catalog::SearchDatasetsRequest,
200    ) -> Result<
201        super::super::super::super::objects::scout::catalog::SearchDatasetsResponse,
202        conjure_http::private::Error,
203    >;
204    #[endpoint(
205        method = PUT,
206        path = "/catalog/v1/datasets/ingest-status-v2",
207        name = "updateDatasetIngestStatusV2",
208        accept = conjure_http::client::StdResponseDeserializer
209    )]
210    fn update_dataset_ingest_status_v2(
211        &self,
212        #[auth]
213        auth_: &conjure_object::BearerToken,
214        #[body(serializer = conjure_http::client::StdRequestSerializer)]
215        details: &super::super::super::super::objects::scout::catalog::UpdateIngestStatusV2,
216    ) -> Result<
217        super::super::super::super::objects::api::IngestStatusV2,
218        conjure_http::private::Error,
219    >;
220    #[endpoint(
221        method = GET,
222        path = "/catalog/v1/datasets/{datasetRid}/ingest-progress-v2",
223        name = "getIngestProgressV2",
224        accept = conjure_http::client::StdResponseDeserializer
225    )]
226    fn get_ingest_progress_v2(
227        &self,
228        #[auth]
229        auth_: &conjure_object::BearerToken,
230        #[path(
231            name = "datasetRid",
232            encoder = conjure_http::client::conjure::PlainEncoder
233        )]
234        dataset_rid: &conjure_object::ResourceIdentifier,
235    ) -> Result<
236        super::super::super::super::objects::scout::catalog::IngestProgressV2,
237        conjure_http::private::Error,
238    >;
239    #[endpoint(
240        method = GET,
241        path = "/catalog/v1/datasets/{dataset}/handle",
242        name = "getHandleForDataset",
243        accept = conjure_http::client::conjure::CollectionResponseDeserializer
244    )]
245    fn get_handle_for_dataset(
246        &self,
247        #[auth]
248        auth_: &conjure_object::BearerToken,
249        #[path(name = "dataset", encoder = conjure_http::client::conjure::PlainEncoder)]
250        dataset: conjure_object::Uuid,
251    ) -> Result<
252        Option<super::super::super::super::objects::scout::catalog::Handle>,
253        conjure_http::private::Error,
254    >;
255    #[endpoint(
256        method = POST,
257        path = "/catalog/v1/datasets",
258        name = "createDataset",
259        accept = conjure_http::client::StdResponseDeserializer
260    )]
261    fn create_dataset(
262        &self,
263        #[auth]
264        auth_: &conjure_object::BearerToken,
265        #[body(serializer = conjure_http::client::StdRequestSerializer)]
266        details: &super::super::super::super::objects::scout::catalog::CreateDataset,
267    ) -> Result<
268        super::super::super::super::objects::scout::catalog::EnrichedDataset,
269        conjure_http::private::Error,
270    >;
271    /// Creates a dataset if the s3 path does not exist, otherwise updates the dataset
272    #[endpoint(
273        method = POST,
274        path = "/catalog/v1/datasets/create-or-update",
275        name = "createOrUpdateDataset",
276        accept = conjure_http::client::StdResponseDeserializer
277    )]
278    fn create_or_update_dataset(
279        &self,
280        #[auth]
281        auth_: &conjure_object::BearerToken,
282        #[body(serializer = conjure_http::client::StdRequestSerializer)]
283        details: &super::super::super::super::objects::scout::catalog::CreateDataset,
284    ) -> Result<
285        super::super::super::super::objects::scout::catalog::EnrichedDataset,
286        conjure_http::private::Error,
287    >;
288    /// Creates a dataset with a specific UUID. This is useful for migrations and advanced use cases
289    /// where the dataset UUID must be controlled by the caller. Throws a conflict error if a dataset
290    /// with the specified UUID already exists. This endpoint is not intended for general use. Use /datasets instead to create a new dataset.
291    #[endpoint(
292        method = POST,
293        path = "/catalog/v1/datasets/with-uuid",
294        name = "createDatasetWithUuid",
295        accept = conjure_http::client::StdResponseDeserializer
296    )]
297    fn create_dataset_with_uuid(
298        &self,
299        #[auth]
300        auth_: &conjure_object::BearerToken,
301        #[body(serializer = conjure_http::client::StdRequestSerializer)]
302        request: &super::super::super::super::objects::scout::catalog::CreateDatasetWithUuidRequest,
303    ) -> Result<
304        super::super::super::super::objects::scout::catalog::EnrichedDataset,
305        conjure_http::private::Error,
306    >;
307    /// Adds a single file to an existing dataset.
308    #[endpoint(
309        method = POST,
310        path = "/catalog/v1/datasets/{datasetRid}/add-file",
311        name = "addFileToDataset",
312        accept = conjure_http::client::StdResponseDeserializer
313    )]
314    fn add_file_to_dataset(
315        &self,
316        #[auth]
317        auth_: &conjure_object::BearerToken,
318        #[path(
319            name = "datasetRid",
320            encoder = conjure_http::client::conjure::PlainEncoder
321        )]
322        dataset_rid: &conjure_object::ResourceIdentifier,
323        #[body(serializer = conjure_http::client::StdRequestSerializer)]
324        request: &super::super::super::super::objects::scout::catalog::AddFileToDataset,
325    ) -> Result<
326        super::super::super::super::objects::scout::catalog::DatasetFile,
327        conjure_http::private::Error,
328    >;
329    #[endpoint(
330        method = GET,
331        path = "/catalog/v1/datasets/{datasetRid}/files",
332        name = "listDatasetFiles",
333        accept = conjure_http::client::StdResponseDeserializer
334    )]
335    fn list_dataset_files(
336        &self,
337        #[auth]
338        auth_: &conjure_object::BearerToken,
339        #[path(
340            name = "datasetRid",
341            encoder = conjure_http::client::conjure::PlainEncoder
342        )]
343        dataset_rid: &conjure_object::ResourceIdentifier,
344        #[query(
345            name = "nextPageToken",
346            encoder = conjure_http::client::conjure::PlainSeqEncoder
347        )]
348        next_page_token: Option<&super::super::super::super::objects::api::Token>,
349    ) -> Result<
350        super::super::super::super::objects::scout::catalog::DatasetFilesPage,
351        conjure_http::private::Error,
352    >;
353    #[endpoint(
354        method = POST,
355        path = "/catalog/v1/search-dataset-files",
356        name = "searchDatasetFiles",
357        accept = conjure_http::client::StdResponseDeserializer
358    )]
359    fn search_dataset_files(
360        &self,
361        #[auth]
362        auth_: &conjure_object::BearerToken,
363        #[body(serializer = conjure_http::client::StdRequestSerializer)]
364        request: &super::super::super::super::objects::scout::catalog::SearchDatasetFilesRequest,
365    ) -> Result<
366        super::super::super::super::objects::scout::catalog::SearchDatasetFilesResponse,
367        conjure_http::private::Error,
368    >;
369    #[endpoint(
370        method = GET,
371        path = "/catalog/v1/datasets/{datasetRid}/{fileId}/uri",
372        name = "getDatasetFileUri",
373        accept = conjure_http::client::StdResponseDeserializer
374    )]
375    fn get_dataset_file_uri(
376        &self,
377        #[auth]
378        auth_: &conjure_object::BearerToken,
379        #[path(
380            name = "datasetRid",
381            encoder = conjure_http::client::conjure::PlainEncoder
382        )]
383        dataset_rid: &super::super::super::super::objects::api::rids::DatasetRid,
384        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
385        file_id: super::super::super::super::objects::datasource::DatasetFileId,
386    ) -> Result<
387        super::super::super::super::objects::scout::catalog::DatasetFileUri,
388        conjure_http::private::Error,
389    >;
390    #[endpoint(
391        method = GET,
392        path = "/catalog/v1/videos/{videoFileRid}/uri",
393        name = "getVideoFileUri",
394        accept = conjure_http::client::StdResponseDeserializer
395    )]
396    fn get_video_file_uri(
397        &self,
398        #[auth]
399        auth_: &conjure_object::BearerToken,
400        #[path(
401            name = "videoFileRid",
402            encoder = conjure_http::client::conjure::PlainEncoder
403        )]
404        video_file_rid: &super::super::super::super::objects::api::rids::VideoFileRid,
405    ) -> Result<
406        super::super::super::super::objects::scout::catalog::VideoFileUri,
407        conjure_http::private::Error,
408    >;
409    #[endpoint(
410        method = GET,
411        path = "/catalog/v1/datasets/{datasetRid}/{fileId}/origin-uris",
412        name = "getOriginFileUris",
413        accept = conjure_http::client::conjure::CollectionResponseDeserializer
414    )]
415    fn get_origin_file_uris(
416        &self,
417        #[auth]
418        auth_: &conjure_object::BearerToken,
419        #[path(
420            name = "datasetRid",
421            encoder = conjure_http::client::conjure::PlainEncoder
422        )]
423        dataset_rid: &super::super::super::super::objects::api::rids::DatasetRid,
424        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
425        file_id: super::super::super::super::objects::datasource::DatasetFileId,
426    ) -> Result<
427        Vec<super::super::super::super::objects::scout::catalog::OriginFileUri>,
428        conjure_http::private::Error,
429    >;
430    #[endpoint(
431        method = PUT,
432        path = "/catalog/v1/datasets/{datasetRid}/file/{fileId}/success",
433        name = "markFileIngestSuccessful",
434        accept = conjure_http::client::StdResponseDeserializer
435    )]
436    fn mark_file_ingest_successful(
437        &self,
438        #[auth]
439        auth_: &conjure_object::BearerToken,
440        #[path(
441            name = "datasetRid",
442            encoder = conjure_http::client::conjure::PlainEncoder
443        )]
444        dataset_rid: &conjure_object::ResourceIdentifier,
445        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
446        file_id: super::super::super::super::objects::datasource::DatasetFileId,
447        #[body(serializer = conjure_http::client::StdRequestSerializer)]
448        request: &super::super::super::super::objects::scout::catalog::MarkFileIngestSuccessful,
449    ) -> Result<
450        super::super::super::super::objects::scout::catalog::DatasetFile,
451        conjure_http::private::Error,
452    >;
453    #[endpoint(
454        method = PUT,
455        path = "/catalog/v1/datasets/{datasetRid}/file/{fileId}/error",
456        name = "markFileIngestError",
457        accept = conjure_http::client::StdResponseDeserializer
458    )]
459    fn mark_file_ingest_error(
460        &self,
461        #[auth]
462        auth_: &conjure_object::BearerToken,
463        #[path(
464            name = "datasetRid",
465            encoder = conjure_http::client::conjure::PlainEncoder
466        )]
467        dataset_rid: &conjure_object::ResourceIdentifier,
468        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
469        file_id: super::super::super::super::objects::datasource::DatasetFileId,
470        #[body(serializer = conjure_http::client::StdRequestSerializer)]
471        request: &super::super::super::super::objects::scout::catalog::MarkFileIngestError,
472    ) -> Result<
473        super::super::super::super::objects::scout::catalog::DatasetFile,
474        conjure_http::private::Error,
475    >;
476    /// Updates file-type-specific metadata for a dataset file. Currently used to update video segment metadata
477    /// after video segmentation is complete.
478    #[endpoint(
479        method = PUT,
480        path = "/catalog/v1/datasets/{datasetRid}/file/{fileId}/metadata",
481        name = "updateDatasetFileMetadata",
482        accept = conjure_http::client::StdResponseDeserializer
483    )]
484    fn update_dataset_file_metadata(
485        &self,
486        #[auth]
487        auth_: &conjure_object::BearerToken,
488        #[path(
489            name = "datasetRid",
490            encoder = conjure_http::client::conjure::PlainEncoder
491        )]
492        dataset_rid: &super::super::super::super::objects::api::rids::DatasetRid,
493        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
494        file_id: super::super::super::super::objects::datasource::DatasetFileId,
495        #[body(serializer = conjure_http::client::StdRequestSerializer)]
496        metadata: &super::super::super::super::objects::scout::catalog::DatasetFileMetadata,
497    ) -> Result<
498        super::super::super::super::objects::scout::catalog::DatasetFile,
499        conjure_http::private::Error,
500    >;
501    #[endpoint(
502        method = PUT,
503        path = "/catalog/v1/datasets/{datasetRid}",
504        name = "updateDatasetMetadata",
505        accept = conjure_http::client::StdResponseDeserializer
506    )]
507    fn update_dataset_metadata(
508        &self,
509        #[auth]
510        auth_: &conjure_object::BearerToken,
511        #[path(
512            name = "datasetRid",
513            encoder = conjure_http::client::conjure::PlainEncoder
514        )]
515        dataset_rid: &conjure_object::ResourceIdentifier,
516        #[body(serializer = conjure_http::client::StdRequestSerializer)]
517        request: &super::super::super::super::objects::scout::catalog::UpdateDatasetMetadata,
518    ) -> Result<
519        super::super::super::super::objects::scout::catalog::EnrichedDataset,
520        conjure_http::private::Error,
521    >;
522    /// Update the bounds for a dataset without updating bounds of files within the dataset. If the
523    /// current bounds of the dataset are not set, then the bounds of the request will be used. Otherwise,
524    /// the bounds will be min(current start, request start), max(current end, request end).
525    #[endpoint(
526        method = PUT,
527        path = "/catalog/v1/datasets/{rid}/bounds-from-streaming",
528        name = "updateGlobalDatasetBounds",
529        accept = conjure_http::client::StdResponseDeserializer
530    )]
531    fn update_global_dataset_bounds(
532        &self,
533        #[auth]
534        auth_: &conjure_object::BearerToken,
535        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
536        rid: &conjure_object::ResourceIdentifier,
537        #[body(serializer = conjure_http::client::StdRequestSerializer)]
538        request: &super::super::super::super::objects::scout::catalog::UpdateBoundsRequest,
539    ) -> Result<
540        super::super::super::super::objects::scout::catalog::Dataset,
541        conjure_http::private::Error,
542    >;
543    /// Archives a dataset, which will hide it from search results unless the includeArchived flag is set to true. The
544    /// dataset can still be directly accessed by its UUID/rid.
545    #[endpoint(
546        method = POST,
547        path = "/catalog/v1/datasets/{datasetRid}/archive",
548        name = "archiveDataset",
549        accept = conjure_http::client::conjure::EmptyResponseDeserializer
550    )]
551    fn archive_dataset(
552        &self,
553        #[auth]
554        auth_: &conjure_object::BearerToken,
555        #[path(
556            name = "datasetRid",
557            encoder = conjure_http::client::conjure::PlainEncoder
558        )]
559        dataset_rid: &conjure_object::ResourceIdentifier,
560    ) -> Result<(), conjure_http::private::Error>;
561    /// Undoes the archiving of a dataset.
562    #[endpoint(
563        method = POST,
564        path = "/catalog/v1/datasets/{datasetRid}/unarchive",
565        name = "unarchiveDataset",
566        accept = conjure_http::client::conjure::EmptyResponseDeserializer
567    )]
568    fn unarchive_dataset(
569        &self,
570        #[auth]
571        auth_: &conjure_object::BearerToken,
572        #[path(
573            name = "datasetRid",
574            encoder = conjure_http::client::conjure::PlainEncoder
575        )]
576        dataset_rid: &conjure_object::ResourceIdentifier,
577    ) -> Result<(), conjure_http::private::Error>;
578    #[endpoint(
579        method = GET,
580        path = "/catalog/v1/datasets/all-properties-labels",
581        name = "getAllPropertiesAndLabels",
582        accept = conjure_http::client::StdResponseDeserializer
583    )]
584    fn get_all_properties_and_labels(
585        &self,
586        #[auth]
587        auth_: &conjure_object::BearerToken,
588        #[query(
589            name = "workspaces",
590            encoder = conjure_http::client::conjure::PlainSeqEncoder
591        )]
592        workspaces: &std::collections::BTreeSet<
593            super::super::super::super::objects::api::rids::WorkspaceRid,
594        >,
595    ) -> Result<
596        super::super::super::super::objects::scout::catalog::AllPropertiesAndLabelsResponse,
597        conjure_http::private::Error,
598    >;
599    /// Returns the log dataset RID for the specified workspace if configured and accessible to the caller.
600    #[endpoint(
601        method = GET,
602        path = "/catalog/v1/workspaces/{workspaceRid}/log-dataset",
603        name = "getLogDatasetForWorkspace",
604        accept = conjure_http::client::conjure::CollectionResponseDeserializer
605    )]
606    fn get_log_dataset_for_workspace(
607        &self,
608        #[auth]
609        auth_: &conjure_object::BearerToken,
610        #[path(
611            name = "workspaceRid",
612            encoder = conjure_http::client::conjure::PlainEncoder
613        )]
614        workspace_rid: &super::super::super::super::objects::api::rids::WorkspaceRid,
615    ) -> Result<
616        Option<super::super::super::super::objects::api::rids::DatasetRid>,
617        conjure_http::private::Error,
618    >;
619}
620/// The Catalog Service provides the ability to query for information about Datasets that are stored in
621/// the Nominal platform. A Dataset is the Nominal representation of data that has been uploaded to Nominal via
622/// a file, primarily CSV.
623#[conjure_http::conjure_client(name = "CatalogService")]
624pub trait AsyncCatalogService<
625    #[response_body]
626    I: conjure_http::private::Stream<
627            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
628        >,
629> {
630    #[endpoint(
631        method = GET,
632        path = "/catalog/v1/datasets/{datasetUuid}",
633        name = "getEnrichedDataset",
634        accept = conjure_http::client::StdResponseDeserializer
635    )]
636    async fn get_enriched_dataset(
637        &self,
638        #[auth]
639        auth_: &conjure_object::BearerToken,
640        #[path(
641            name = "datasetUuid",
642            encoder = conjure_http::client::conjure::PlainEncoder
643        )]
644        dataset_uuid: conjure_object::Uuid,
645    ) -> Result<
646        super::super::super::super::objects::scout::catalog::EnrichedDataset,
647        conjure_http::private::Error,
648    >;
649    #[endpoint(
650        method = POST,
651        path = "/catalog/v1/datasets/multiple",
652        name = "getEnrichedDatasets",
653        accept = conjure_http::client::conjure::CollectionResponseDeserializer
654    )]
655    async fn get_enriched_datasets(
656        &self,
657        #[auth]
658        auth_: &conjure_object::BearerToken,
659        #[body(serializer = conjure_http::client::StdRequestSerializer)]
660        get_datasets_request: &super::super::super::super::objects::scout::catalog::GetDatasetsRequest,
661    ) -> Result<
662        std::collections::BTreeSet<
663            super::super::super::super::objects::scout::catalog::EnrichedDataset,
664        >,
665        conjure_http::private::Error,
666    >;
667    #[endpoint(
668        method = GET,
669        path = "/catalog/v1/datasets-simple/{datasetUuid}",
670        name = "getDataset",
671        accept = conjure_http::client::StdResponseDeserializer
672    )]
673    async fn get_dataset(
674        &self,
675        #[auth]
676        auth_: &conjure_object::BearerToken,
677        #[path(
678            name = "datasetUuid",
679            encoder = conjure_http::client::conjure::PlainEncoder
680        )]
681        dataset_uuid: conjure_object::Uuid,
682    ) -> Result<
683        super::super::super::super::objects::scout::catalog::Dataset,
684        conjure_http::private::Error,
685    >;
686    #[endpoint(
687        method = POST,
688        path = "/catalog/v1/datasets-simple/multiple",
689        name = "getDatasets",
690        accept = conjure_http::client::conjure::CollectionResponseDeserializer
691    )]
692    async fn get_datasets(
693        &self,
694        #[auth]
695        auth_: &conjure_object::BearerToken,
696        #[body(serializer = conjure_http::client::StdRequestSerializer)]
697        get_datasets_request: &super::super::super::super::objects::scout::catalog::GetDatasetsRequest,
698    ) -> Result<
699        std::collections::BTreeSet<
700            super::super::super::super::objects::scout::catalog::Dataset,
701        >,
702        conjure_http::private::Error,
703    >;
704    /// Gets the subset of dataset RIDs that currently have external connection config attached.
705    #[endpoint(
706        method = POST,
707        path = "/catalog/v1/datasets-simple/external-config",
708        name = "getDatasetsWithExternalConnectionConfig",
709        accept = conjure_http::client::conjure::CollectionResponseDeserializer
710    )]
711    async fn get_datasets_with_external_connection_config(
712        &self,
713        #[auth]
714        auth_: &conjure_object::BearerToken,
715        #[body(serializer = conjure_http::client::StdRequestSerializer)]
716        get_datasets_request: &super::super::super::super::objects::scout::catalog::GetDatasetsRequest,
717    ) -> Result<
718        std::collections::BTreeSet<
719            super::super::super::super::objects::api::rids::DatasetRid,
720        >,
721        conjure_http::private::Error,
722    >;
723    /// Registers or updates external connection configuration for an existing dataset.
724    #[endpoint(
725        method = POST,
726        path = "/catalog/v1/datasets/external-config",
727        name = "registerExternalConnectionConfig",
728        accept = conjure_http::client::StdResponseDeserializer
729    )]
730    async fn register_external_connection_config(
731        &self,
732        #[auth]
733        auth_: &conjure_object::BearerToken,
734        #[body(serializer = conjure_http::client::StdRequestSerializer)]
735        request: &super::super::super::super::objects::scout::catalog::RegisterExternalConnectionConfigRequest,
736    ) -> Result<
737        super::super::super::super::objects::scout::catalog::EnrichedDataset,
738        conjure_http::private::Error,
739    >;
740    #[endpoint(
741        method = GET,
742        path = "/catalog/v1/dataset/{datasetRid}/file/{fileId}",
743        name = "getDatasetFile",
744        accept = conjure_http::client::StdResponseDeserializer
745    )]
746    async fn get_dataset_file(
747        &self,
748        #[auth]
749        auth_: &conjure_object::BearerToken,
750        #[path(
751            name = "datasetRid",
752            encoder = conjure_http::client::conjure::PlainEncoder
753        )]
754        dataset_rid: &conjure_object::ResourceIdentifier,
755        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
756        file_id: super::super::super::super::objects::datasource::DatasetFileId,
757    ) -> Result<
758        super::super::super::super::objects::scout::catalog::DatasetFile,
759        conjure_http::private::Error,
760    >;
761    /// Returns dataset files for the given file IDs within a single dataset. Only returns files that
762    /// exist and belong to the specified dataset. Useful for checking ingestion status of many files at once.
763    #[endpoint(
764        method = POST,
765        path = "/catalog/v1/dataset-files/batchGet",
766        name = "batchGetDatasetFiles",
767        accept = conjure_http::client::conjure::CollectionResponseDeserializer
768    )]
769    async fn batch_get_dataset_files(
770        &self,
771        #[auth]
772        auth_: &conjure_object::BearerToken,
773        #[body(serializer = conjure_http::client::StdRequestSerializer)]
774        request: &super::super::super::super::objects::scout::catalog::BatchGetDatasetFilesRequest,
775    ) -> Result<
776        std::collections::BTreeMap<
777            super::super::super::super::objects::datasource::DatasetFileId,
778            super::super::super::super::objects::scout::catalog::DatasetFile,
779        >,
780        conjure_http::private::Error,
781    >;
782    #[endpoint(
783        method = GET,
784        path = "/catalog/v1/ingest-job/{ingestJobRid}/files",
785        name = "getDatasetFilesForJob",
786        accept = conjure_http::client::StdResponseDeserializer
787    )]
788    async fn get_dataset_files_for_job(
789        &self,
790        #[auth]
791        auth_: &conjure_object::BearerToken,
792        #[path(
793            name = "ingestJobRid",
794            encoder = conjure_http::client::conjure::PlainEncoder
795        )]
796        ingest_job_rid: &conjure_object::ResourceIdentifier,
797        #[query(
798            name = "nextPageToken",
799            encoder = conjure_http::client::conjure::PlainSeqEncoder
800        )]
801        next_page_token: Option<&super::super::super::super::objects::api::Token>,
802    ) -> Result<
803        super::super::super::super::objects::scout::catalog::DatasetFilesPage,
804        conjure_http::private::Error,
805    >;
806    #[endpoint(
807        method = POST,
808        path = "/catalog/v1/search-datasets-v2",
809        name = "searchDatasets",
810        accept = conjure_http::client::StdResponseDeserializer
811    )]
812    async fn search_datasets(
813        &self,
814        #[auth]
815        auth_: &conjure_object::BearerToken,
816        #[body(serializer = conjure_http::client::StdRequestSerializer)]
817        request: &super::super::super::super::objects::scout::catalog::SearchDatasetsRequest,
818    ) -> Result<
819        super::super::super::super::objects::scout::catalog::SearchDatasetsResponse,
820        conjure_http::private::Error,
821    >;
822    #[endpoint(
823        method = PUT,
824        path = "/catalog/v1/datasets/ingest-status-v2",
825        name = "updateDatasetIngestStatusV2",
826        accept = conjure_http::client::StdResponseDeserializer
827    )]
828    async fn update_dataset_ingest_status_v2(
829        &self,
830        #[auth]
831        auth_: &conjure_object::BearerToken,
832        #[body(serializer = conjure_http::client::StdRequestSerializer)]
833        details: &super::super::super::super::objects::scout::catalog::UpdateIngestStatusV2,
834    ) -> Result<
835        super::super::super::super::objects::api::IngestStatusV2,
836        conjure_http::private::Error,
837    >;
838    #[endpoint(
839        method = GET,
840        path = "/catalog/v1/datasets/{datasetRid}/ingest-progress-v2",
841        name = "getIngestProgressV2",
842        accept = conjure_http::client::StdResponseDeserializer
843    )]
844    async fn get_ingest_progress_v2(
845        &self,
846        #[auth]
847        auth_: &conjure_object::BearerToken,
848        #[path(
849            name = "datasetRid",
850            encoder = conjure_http::client::conjure::PlainEncoder
851        )]
852        dataset_rid: &conjure_object::ResourceIdentifier,
853    ) -> Result<
854        super::super::super::super::objects::scout::catalog::IngestProgressV2,
855        conjure_http::private::Error,
856    >;
857    #[endpoint(
858        method = GET,
859        path = "/catalog/v1/datasets/{dataset}/handle",
860        name = "getHandleForDataset",
861        accept = conjure_http::client::conjure::CollectionResponseDeserializer
862    )]
863    async fn get_handle_for_dataset(
864        &self,
865        #[auth]
866        auth_: &conjure_object::BearerToken,
867        #[path(name = "dataset", encoder = conjure_http::client::conjure::PlainEncoder)]
868        dataset: conjure_object::Uuid,
869    ) -> Result<
870        Option<super::super::super::super::objects::scout::catalog::Handle>,
871        conjure_http::private::Error,
872    >;
873    #[endpoint(
874        method = POST,
875        path = "/catalog/v1/datasets",
876        name = "createDataset",
877        accept = conjure_http::client::StdResponseDeserializer
878    )]
879    async fn create_dataset(
880        &self,
881        #[auth]
882        auth_: &conjure_object::BearerToken,
883        #[body(serializer = conjure_http::client::StdRequestSerializer)]
884        details: &super::super::super::super::objects::scout::catalog::CreateDataset,
885    ) -> Result<
886        super::super::super::super::objects::scout::catalog::EnrichedDataset,
887        conjure_http::private::Error,
888    >;
889    /// Creates a dataset if the s3 path does not exist, otherwise updates the dataset
890    #[endpoint(
891        method = POST,
892        path = "/catalog/v1/datasets/create-or-update",
893        name = "createOrUpdateDataset",
894        accept = conjure_http::client::StdResponseDeserializer
895    )]
896    async fn create_or_update_dataset(
897        &self,
898        #[auth]
899        auth_: &conjure_object::BearerToken,
900        #[body(serializer = conjure_http::client::StdRequestSerializer)]
901        details: &super::super::super::super::objects::scout::catalog::CreateDataset,
902    ) -> Result<
903        super::super::super::super::objects::scout::catalog::EnrichedDataset,
904        conjure_http::private::Error,
905    >;
906    /// Creates a dataset with a specific UUID. This is useful for migrations and advanced use cases
907    /// where the dataset UUID must be controlled by the caller. Throws a conflict error if a dataset
908    /// with the specified UUID already exists. This endpoint is not intended for general use. Use /datasets instead to create a new dataset.
909    #[endpoint(
910        method = POST,
911        path = "/catalog/v1/datasets/with-uuid",
912        name = "createDatasetWithUuid",
913        accept = conjure_http::client::StdResponseDeserializer
914    )]
915    async fn create_dataset_with_uuid(
916        &self,
917        #[auth]
918        auth_: &conjure_object::BearerToken,
919        #[body(serializer = conjure_http::client::StdRequestSerializer)]
920        request: &super::super::super::super::objects::scout::catalog::CreateDatasetWithUuidRequest,
921    ) -> Result<
922        super::super::super::super::objects::scout::catalog::EnrichedDataset,
923        conjure_http::private::Error,
924    >;
925    /// Adds a single file to an existing dataset.
926    #[endpoint(
927        method = POST,
928        path = "/catalog/v1/datasets/{datasetRid}/add-file",
929        name = "addFileToDataset",
930        accept = conjure_http::client::StdResponseDeserializer
931    )]
932    async fn add_file_to_dataset(
933        &self,
934        #[auth]
935        auth_: &conjure_object::BearerToken,
936        #[path(
937            name = "datasetRid",
938            encoder = conjure_http::client::conjure::PlainEncoder
939        )]
940        dataset_rid: &conjure_object::ResourceIdentifier,
941        #[body(serializer = conjure_http::client::StdRequestSerializer)]
942        request: &super::super::super::super::objects::scout::catalog::AddFileToDataset,
943    ) -> Result<
944        super::super::super::super::objects::scout::catalog::DatasetFile,
945        conjure_http::private::Error,
946    >;
947    #[endpoint(
948        method = GET,
949        path = "/catalog/v1/datasets/{datasetRid}/files",
950        name = "listDatasetFiles",
951        accept = conjure_http::client::StdResponseDeserializer
952    )]
953    async fn list_dataset_files(
954        &self,
955        #[auth]
956        auth_: &conjure_object::BearerToken,
957        #[path(
958            name = "datasetRid",
959            encoder = conjure_http::client::conjure::PlainEncoder
960        )]
961        dataset_rid: &conjure_object::ResourceIdentifier,
962        #[query(
963            name = "nextPageToken",
964            encoder = conjure_http::client::conjure::PlainSeqEncoder
965        )]
966        next_page_token: Option<&super::super::super::super::objects::api::Token>,
967    ) -> Result<
968        super::super::super::super::objects::scout::catalog::DatasetFilesPage,
969        conjure_http::private::Error,
970    >;
971    #[endpoint(
972        method = POST,
973        path = "/catalog/v1/search-dataset-files",
974        name = "searchDatasetFiles",
975        accept = conjure_http::client::StdResponseDeserializer
976    )]
977    async fn search_dataset_files(
978        &self,
979        #[auth]
980        auth_: &conjure_object::BearerToken,
981        #[body(serializer = conjure_http::client::StdRequestSerializer)]
982        request: &super::super::super::super::objects::scout::catalog::SearchDatasetFilesRequest,
983    ) -> Result<
984        super::super::super::super::objects::scout::catalog::SearchDatasetFilesResponse,
985        conjure_http::private::Error,
986    >;
987    #[endpoint(
988        method = GET,
989        path = "/catalog/v1/datasets/{datasetRid}/{fileId}/uri",
990        name = "getDatasetFileUri",
991        accept = conjure_http::client::StdResponseDeserializer
992    )]
993    async fn get_dataset_file_uri(
994        &self,
995        #[auth]
996        auth_: &conjure_object::BearerToken,
997        #[path(
998            name = "datasetRid",
999            encoder = conjure_http::client::conjure::PlainEncoder
1000        )]
1001        dataset_rid: &super::super::super::super::objects::api::rids::DatasetRid,
1002        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1003        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1004    ) -> Result<
1005        super::super::super::super::objects::scout::catalog::DatasetFileUri,
1006        conjure_http::private::Error,
1007    >;
1008    #[endpoint(
1009        method = GET,
1010        path = "/catalog/v1/videos/{videoFileRid}/uri",
1011        name = "getVideoFileUri",
1012        accept = conjure_http::client::StdResponseDeserializer
1013    )]
1014    async fn get_video_file_uri(
1015        &self,
1016        #[auth]
1017        auth_: &conjure_object::BearerToken,
1018        #[path(
1019            name = "videoFileRid",
1020            encoder = conjure_http::client::conjure::PlainEncoder
1021        )]
1022        video_file_rid: &super::super::super::super::objects::api::rids::VideoFileRid,
1023    ) -> Result<
1024        super::super::super::super::objects::scout::catalog::VideoFileUri,
1025        conjure_http::private::Error,
1026    >;
1027    #[endpoint(
1028        method = GET,
1029        path = "/catalog/v1/datasets/{datasetRid}/{fileId}/origin-uris",
1030        name = "getOriginFileUris",
1031        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1032    )]
1033    async fn get_origin_file_uris(
1034        &self,
1035        #[auth]
1036        auth_: &conjure_object::BearerToken,
1037        #[path(
1038            name = "datasetRid",
1039            encoder = conjure_http::client::conjure::PlainEncoder
1040        )]
1041        dataset_rid: &super::super::super::super::objects::api::rids::DatasetRid,
1042        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1043        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1044    ) -> Result<
1045        Vec<super::super::super::super::objects::scout::catalog::OriginFileUri>,
1046        conjure_http::private::Error,
1047    >;
1048    #[endpoint(
1049        method = PUT,
1050        path = "/catalog/v1/datasets/{datasetRid}/file/{fileId}/success",
1051        name = "markFileIngestSuccessful",
1052        accept = conjure_http::client::StdResponseDeserializer
1053    )]
1054    async fn mark_file_ingest_successful(
1055        &self,
1056        #[auth]
1057        auth_: &conjure_object::BearerToken,
1058        #[path(
1059            name = "datasetRid",
1060            encoder = conjure_http::client::conjure::PlainEncoder
1061        )]
1062        dataset_rid: &conjure_object::ResourceIdentifier,
1063        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1064        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1065        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1066        request: &super::super::super::super::objects::scout::catalog::MarkFileIngestSuccessful,
1067    ) -> Result<
1068        super::super::super::super::objects::scout::catalog::DatasetFile,
1069        conjure_http::private::Error,
1070    >;
1071    #[endpoint(
1072        method = PUT,
1073        path = "/catalog/v1/datasets/{datasetRid}/file/{fileId}/error",
1074        name = "markFileIngestError",
1075        accept = conjure_http::client::StdResponseDeserializer
1076    )]
1077    async fn mark_file_ingest_error(
1078        &self,
1079        #[auth]
1080        auth_: &conjure_object::BearerToken,
1081        #[path(
1082            name = "datasetRid",
1083            encoder = conjure_http::client::conjure::PlainEncoder
1084        )]
1085        dataset_rid: &conjure_object::ResourceIdentifier,
1086        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1087        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1088        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1089        request: &super::super::super::super::objects::scout::catalog::MarkFileIngestError,
1090    ) -> Result<
1091        super::super::super::super::objects::scout::catalog::DatasetFile,
1092        conjure_http::private::Error,
1093    >;
1094    /// Updates file-type-specific metadata for a dataset file. Currently used to update video segment metadata
1095    /// after video segmentation is complete.
1096    #[endpoint(
1097        method = PUT,
1098        path = "/catalog/v1/datasets/{datasetRid}/file/{fileId}/metadata",
1099        name = "updateDatasetFileMetadata",
1100        accept = conjure_http::client::StdResponseDeserializer
1101    )]
1102    async fn update_dataset_file_metadata(
1103        &self,
1104        #[auth]
1105        auth_: &conjure_object::BearerToken,
1106        #[path(
1107            name = "datasetRid",
1108            encoder = conjure_http::client::conjure::PlainEncoder
1109        )]
1110        dataset_rid: &super::super::super::super::objects::api::rids::DatasetRid,
1111        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1112        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1113        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1114        metadata: &super::super::super::super::objects::scout::catalog::DatasetFileMetadata,
1115    ) -> Result<
1116        super::super::super::super::objects::scout::catalog::DatasetFile,
1117        conjure_http::private::Error,
1118    >;
1119    #[endpoint(
1120        method = PUT,
1121        path = "/catalog/v1/datasets/{datasetRid}",
1122        name = "updateDatasetMetadata",
1123        accept = conjure_http::client::StdResponseDeserializer
1124    )]
1125    async fn update_dataset_metadata(
1126        &self,
1127        #[auth]
1128        auth_: &conjure_object::BearerToken,
1129        #[path(
1130            name = "datasetRid",
1131            encoder = conjure_http::client::conjure::PlainEncoder
1132        )]
1133        dataset_rid: &conjure_object::ResourceIdentifier,
1134        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1135        request: &super::super::super::super::objects::scout::catalog::UpdateDatasetMetadata,
1136    ) -> Result<
1137        super::super::super::super::objects::scout::catalog::EnrichedDataset,
1138        conjure_http::private::Error,
1139    >;
1140    /// Update the bounds for a dataset without updating bounds of files within the dataset. If the
1141    /// current bounds of the dataset are not set, then the bounds of the request will be used. Otherwise,
1142    /// the bounds will be min(current start, request start), max(current end, request end).
1143    #[endpoint(
1144        method = PUT,
1145        path = "/catalog/v1/datasets/{rid}/bounds-from-streaming",
1146        name = "updateGlobalDatasetBounds",
1147        accept = conjure_http::client::StdResponseDeserializer
1148    )]
1149    async fn update_global_dataset_bounds(
1150        &self,
1151        #[auth]
1152        auth_: &conjure_object::BearerToken,
1153        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
1154        rid: &conjure_object::ResourceIdentifier,
1155        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1156        request: &super::super::super::super::objects::scout::catalog::UpdateBoundsRequest,
1157    ) -> Result<
1158        super::super::super::super::objects::scout::catalog::Dataset,
1159        conjure_http::private::Error,
1160    >;
1161    /// Archives a dataset, which will hide it from search results unless the includeArchived flag is set to true. The
1162    /// dataset can still be directly accessed by its UUID/rid.
1163    #[endpoint(
1164        method = POST,
1165        path = "/catalog/v1/datasets/{datasetRid}/archive",
1166        name = "archiveDataset",
1167        accept = conjure_http::client::conjure::EmptyResponseDeserializer
1168    )]
1169    async fn archive_dataset(
1170        &self,
1171        #[auth]
1172        auth_: &conjure_object::BearerToken,
1173        #[path(
1174            name = "datasetRid",
1175            encoder = conjure_http::client::conjure::PlainEncoder
1176        )]
1177        dataset_rid: &conjure_object::ResourceIdentifier,
1178    ) -> Result<(), conjure_http::private::Error>;
1179    /// Undoes the archiving of a dataset.
1180    #[endpoint(
1181        method = POST,
1182        path = "/catalog/v1/datasets/{datasetRid}/unarchive",
1183        name = "unarchiveDataset",
1184        accept = conjure_http::client::conjure::EmptyResponseDeserializer
1185    )]
1186    async fn unarchive_dataset(
1187        &self,
1188        #[auth]
1189        auth_: &conjure_object::BearerToken,
1190        #[path(
1191            name = "datasetRid",
1192            encoder = conjure_http::client::conjure::PlainEncoder
1193        )]
1194        dataset_rid: &conjure_object::ResourceIdentifier,
1195    ) -> Result<(), conjure_http::private::Error>;
1196    #[endpoint(
1197        method = GET,
1198        path = "/catalog/v1/datasets/all-properties-labels",
1199        name = "getAllPropertiesAndLabels",
1200        accept = conjure_http::client::StdResponseDeserializer
1201    )]
1202    async fn get_all_properties_and_labels(
1203        &self,
1204        #[auth]
1205        auth_: &conjure_object::BearerToken,
1206        #[query(
1207            name = "workspaces",
1208            encoder = conjure_http::client::conjure::PlainSeqEncoder
1209        )]
1210        workspaces: &std::collections::BTreeSet<
1211            super::super::super::super::objects::api::rids::WorkspaceRid,
1212        >,
1213    ) -> Result<
1214        super::super::super::super::objects::scout::catalog::AllPropertiesAndLabelsResponse,
1215        conjure_http::private::Error,
1216    >;
1217    /// Returns the log dataset RID for the specified workspace if configured and accessible to the caller.
1218    #[endpoint(
1219        method = GET,
1220        path = "/catalog/v1/workspaces/{workspaceRid}/log-dataset",
1221        name = "getLogDatasetForWorkspace",
1222        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1223    )]
1224    async fn get_log_dataset_for_workspace(
1225        &self,
1226        #[auth]
1227        auth_: &conjure_object::BearerToken,
1228        #[path(
1229            name = "workspaceRid",
1230            encoder = conjure_http::client::conjure::PlainEncoder
1231        )]
1232        workspace_rid: &super::super::super::super::objects::api::rids::WorkspaceRid,
1233    ) -> Result<
1234        Option<super::super::super::super::objects::api::rids::DatasetRid>,
1235        conjure_http::private::Error,
1236    >;
1237}
1238/// The Catalog Service provides the ability to query for information about Datasets that are stored in
1239/// the Nominal platform. A Dataset is the Nominal representation of data that has been uploaded to Nominal via
1240/// a file, primarily CSV.
1241#[conjure_http::conjure_client(name = "CatalogService", local)]
1242pub trait LocalAsyncCatalogService<
1243    #[response_body]
1244    I: conjure_http::private::Stream<
1245            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
1246        >,
1247> {
1248    #[endpoint(
1249        method = GET,
1250        path = "/catalog/v1/datasets/{datasetUuid}",
1251        name = "getEnrichedDataset",
1252        accept = conjure_http::client::StdResponseDeserializer
1253    )]
1254    async fn get_enriched_dataset(
1255        &self,
1256        #[auth]
1257        auth_: &conjure_object::BearerToken,
1258        #[path(
1259            name = "datasetUuid",
1260            encoder = conjure_http::client::conjure::PlainEncoder
1261        )]
1262        dataset_uuid: conjure_object::Uuid,
1263    ) -> Result<
1264        super::super::super::super::objects::scout::catalog::EnrichedDataset,
1265        conjure_http::private::Error,
1266    >;
1267    #[endpoint(
1268        method = POST,
1269        path = "/catalog/v1/datasets/multiple",
1270        name = "getEnrichedDatasets",
1271        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1272    )]
1273    async fn get_enriched_datasets(
1274        &self,
1275        #[auth]
1276        auth_: &conjure_object::BearerToken,
1277        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1278        get_datasets_request: &super::super::super::super::objects::scout::catalog::GetDatasetsRequest,
1279    ) -> Result<
1280        std::collections::BTreeSet<
1281            super::super::super::super::objects::scout::catalog::EnrichedDataset,
1282        >,
1283        conjure_http::private::Error,
1284    >;
1285    #[endpoint(
1286        method = GET,
1287        path = "/catalog/v1/datasets-simple/{datasetUuid}",
1288        name = "getDataset",
1289        accept = conjure_http::client::StdResponseDeserializer
1290    )]
1291    async fn get_dataset(
1292        &self,
1293        #[auth]
1294        auth_: &conjure_object::BearerToken,
1295        #[path(
1296            name = "datasetUuid",
1297            encoder = conjure_http::client::conjure::PlainEncoder
1298        )]
1299        dataset_uuid: conjure_object::Uuid,
1300    ) -> Result<
1301        super::super::super::super::objects::scout::catalog::Dataset,
1302        conjure_http::private::Error,
1303    >;
1304    #[endpoint(
1305        method = POST,
1306        path = "/catalog/v1/datasets-simple/multiple",
1307        name = "getDatasets",
1308        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1309    )]
1310    async fn get_datasets(
1311        &self,
1312        #[auth]
1313        auth_: &conjure_object::BearerToken,
1314        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1315        get_datasets_request: &super::super::super::super::objects::scout::catalog::GetDatasetsRequest,
1316    ) -> Result<
1317        std::collections::BTreeSet<
1318            super::super::super::super::objects::scout::catalog::Dataset,
1319        >,
1320        conjure_http::private::Error,
1321    >;
1322    /// Gets the subset of dataset RIDs that currently have external connection config attached.
1323    #[endpoint(
1324        method = POST,
1325        path = "/catalog/v1/datasets-simple/external-config",
1326        name = "getDatasetsWithExternalConnectionConfig",
1327        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1328    )]
1329    async fn get_datasets_with_external_connection_config(
1330        &self,
1331        #[auth]
1332        auth_: &conjure_object::BearerToken,
1333        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1334        get_datasets_request: &super::super::super::super::objects::scout::catalog::GetDatasetsRequest,
1335    ) -> Result<
1336        std::collections::BTreeSet<
1337            super::super::super::super::objects::api::rids::DatasetRid,
1338        >,
1339        conjure_http::private::Error,
1340    >;
1341    /// Registers or updates external connection configuration for an existing dataset.
1342    #[endpoint(
1343        method = POST,
1344        path = "/catalog/v1/datasets/external-config",
1345        name = "registerExternalConnectionConfig",
1346        accept = conjure_http::client::StdResponseDeserializer
1347    )]
1348    async fn register_external_connection_config(
1349        &self,
1350        #[auth]
1351        auth_: &conjure_object::BearerToken,
1352        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1353        request: &super::super::super::super::objects::scout::catalog::RegisterExternalConnectionConfigRequest,
1354    ) -> Result<
1355        super::super::super::super::objects::scout::catalog::EnrichedDataset,
1356        conjure_http::private::Error,
1357    >;
1358    #[endpoint(
1359        method = GET,
1360        path = "/catalog/v1/dataset/{datasetRid}/file/{fileId}",
1361        name = "getDatasetFile",
1362        accept = conjure_http::client::StdResponseDeserializer
1363    )]
1364    async fn get_dataset_file(
1365        &self,
1366        #[auth]
1367        auth_: &conjure_object::BearerToken,
1368        #[path(
1369            name = "datasetRid",
1370            encoder = conjure_http::client::conjure::PlainEncoder
1371        )]
1372        dataset_rid: &conjure_object::ResourceIdentifier,
1373        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1374        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1375    ) -> Result<
1376        super::super::super::super::objects::scout::catalog::DatasetFile,
1377        conjure_http::private::Error,
1378    >;
1379    /// Returns dataset files for the given file IDs within a single dataset. Only returns files that
1380    /// exist and belong to the specified dataset. Useful for checking ingestion status of many files at once.
1381    #[endpoint(
1382        method = POST,
1383        path = "/catalog/v1/dataset-files/batchGet",
1384        name = "batchGetDatasetFiles",
1385        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1386    )]
1387    async fn batch_get_dataset_files(
1388        &self,
1389        #[auth]
1390        auth_: &conjure_object::BearerToken,
1391        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1392        request: &super::super::super::super::objects::scout::catalog::BatchGetDatasetFilesRequest,
1393    ) -> Result<
1394        std::collections::BTreeMap<
1395            super::super::super::super::objects::datasource::DatasetFileId,
1396            super::super::super::super::objects::scout::catalog::DatasetFile,
1397        >,
1398        conjure_http::private::Error,
1399    >;
1400    #[endpoint(
1401        method = GET,
1402        path = "/catalog/v1/ingest-job/{ingestJobRid}/files",
1403        name = "getDatasetFilesForJob",
1404        accept = conjure_http::client::StdResponseDeserializer
1405    )]
1406    async fn get_dataset_files_for_job(
1407        &self,
1408        #[auth]
1409        auth_: &conjure_object::BearerToken,
1410        #[path(
1411            name = "ingestJobRid",
1412            encoder = conjure_http::client::conjure::PlainEncoder
1413        )]
1414        ingest_job_rid: &conjure_object::ResourceIdentifier,
1415        #[query(
1416            name = "nextPageToken",
1417            encoder = conjure_http::client::conjure::PlainSeqEncoder
1418        )]
1419        next_page_token: Option<&super::super::super::super::objects::api::Token>,
1420    ) -> Result<
1421        super::super::super::super::objects::scout::catalog::DatasetFilesPage,
1422        conjure_http::private::Error,
1423    >;
1424    #[endpoint(
1425        method = POST,
1426        path = "/catalog/v1/search-datasets-v2",
1427        name = "searchDatasets",
1428        accept = conjure_http::client::StdResponseDeserializer
1429    )]
1430    async fn search_datasets(
1431        &self,
1432        #[auth]
1433        auth_: &conjure_object::BearerToken,
1434        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1435        request: &super::super::super::super::objects::scout::catalog::SearchDatasetsRequest,
1436    ) -> Result<
1437        super::super::super::super::objects::scout::catalog::SearchDatasetsResponse,
1438        conjure_http::private::Error,
1439    >;
1440    #[endpoint(
1441        method = PUT,
1442        path = "/catalog/v1/datasets/ingest-status-v2",
1443        name = "updateDatasetIngestStatusV2",
1444        accept = conjure_http::client::StdResponseDeserializer
1445    )]
1446    async fn update_dataset_ingest_status_v2(
1447        &self,
1448        #[auth]
1449        auth_: &conjure_object::BearerToken,
1450        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1451        details: &super::super::super::super::objects::scout::catalog::UpdateIngestStatusV2,
1452    ) -> Result<
1453        super::super::super::super::objects::api::IngestStatusV2,
1454        conjure_http::private::Error,
1455    >;
1456    #[endpoint(
1457        method = GET,
1458        path = "/catalog/v1/datasets/{datasetRid}/ingest-progress-v2",
1459        name = "getIngestProgressV2",
1460        accept = conjure_http::client::StdResponseDeserializer
1461    )]
1462    async fn get_ingest_progress_v2(
1463        &self,
1464        #[auth]
1465        auth_: &conjure_object::BearerToken,
1466        #[path(
1467            name = "datasetRid",
1468            encoder = conjure_http::client::conjure::PlainEncoder
1469        )]
1470        dataset_rid: &conjure_object::ResourceIdentifier,
1471    ) -> Result<
1472        super::super::super::super::objects::scout::catalog::IngestProgressV2,
1473        conjure_http::private::Error,
1474    >;
1475    #[endpoint(
1476        method = GET,
1477        path = "/catalog/v1/datasets/{dataset}/handle",
1478        name = "getHandleForDataset",
1479        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1480    )]
1481    async fn get_handle_for_dataset(
1482        &self,
1483        #[auth]
1484        auth_: &conjure_object::BearerToken,
1485        #[path(name = "dataset", encoder = conjure_http::client::conjure::PlainEncoder)]
1486        dataset: conjure_object::Uuid,
1487    ) -> Result<
1488        Option<super::super::super::super::objects::scout::catalog::Handle>,
1489        conjure_http::private::Error,
1490    >;
1491    #[endpoint(
1492        method = POST,
1493        path = "/catalog/v1/datasets",
1494        name = "createDataset",
1495        accept = conjure_http::client::StdResponseDeserializer
1496    )]
1497    async fn create_dataset(
1498        &self,
1499        #[auth]
1500        auth_: &conjure_object::BearerToken,
1501        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1502        details: &super::super::super::super::objects::scout::catalog::CreateDataset,
1503    ) -> Result<
1504        super::super::super::super::objects::scout::catalog::EnrichedDataset,
1505        conjure_http::private::Error,
1506    >;
1507    /// Creates a dataset if the s3 path does not exist, otherwise updates the dataset
1508    #[endpoint(
1509        method = POST,
1510        path = "/catalog/v1/datasets/create-or-update",
1511        name = "createOrUpdateDataset",
1512        accept = conjure_http::client::StdResponseDeserializer
1513    )]
1514    async fn create_or_update_dataset(
1515        &self,
1516        #[auth]
1517        auth_: &conjure_object::BearerToken,
1518        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1519        details: &super::super::super::super::objects::scout::catalog::CreateDataset,
1520    ) -> Result<
1521        super::super::super::super::objects::scout::catalog::EnrichedDataset,
1522        conjure_http::private::Error,
1523    >;
1524    /// Creates a dataset with a specific UUID. This is useful for migrations and advanced use cases
1525    /// where the dataset UUID must be controlled by the caller. Throws a conflict error if a dataset
1526    /// with the specified UUID already exists. This endpoint is not intended for general use. Use /datasets instead to create a new dataset.
1527    #[endpoint(
1528        method = POST,
1529        path = "/catalog/v1/datasets/with-uuid",
1530        name = "createDatasetWithUuid",
1531        accept = conjure_http::client::StdResponseDeserializer
1532    )]
1533    async fn create_dataset_with_uuid(
1534        &self,
1535        #[auth]
1536        auth_: &conjure_object::BearerToken,
1537        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1538        request: &super::super::super::super::objects::scout::catalog::CreateDatasetWithUuidRequest,
1539    ) -> Result<
1540        super::super::super::super::objects::scout::catalog::EnrichedDataset,
1541        conjure_http::private::Error,
1542    >;
1543    /// Adds a single file to an existing dataset.
1544    #[endpoint(
1545        method = POST,
1546        path = "/catalog/v1/datasets/{datasetRid}/add-file",
1547        name = "addFileToDataset",
1548        accept = conjure_http::client::StdResponseDeserializer
1549    )]
1550    async fn add_file_to_dataset(
1551        &self,
1552        #[auth]
1553        auth_: &conjure_object::BearerToken,
1554        #[path(
1555            name = "datasetRid",
1556            encoder = conjure_http::client::conjure::PlainEncoder
1557        )]
1558        dataset_rid: &conjure_object::ResourceIdentifier,
1559        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1560        request: &super::super::super::super::objects::scout::catalog::AddFileToDataset,
1561    ) -> Result<
1562        super::super::super::super::objects::scout::catalog::DatasetFile,
1563        conjure_http::private::Error,
1564    >;
1565    #[endpoint(
1566        method = GET,
1567        path = "/catalog/v1/datasets/{datasetRid}/files",
1568        name = "listDatasetFiles",
1569        accept = conjure_http::client::StdResponseDeserializer
1570    )]
1571    async fn list_dataset_files(
1572        &self,
1573        #[auth]
1574        auth_: &conjure_object::BearerToken,
1575        #[path(
1576            name = "datasetRid",
1577            encoder = conjure_http::client::conjure::PlainEncoder
1578        )]
1579        dataset_rid: &conjure_object::ResourceIdentifier,
1580        #[query(
1581            name = "nextPageToken",
1582            encoder = conjure_http::client::conjure::PlainSeqEncoder
1583        )]
1584        next_page_token: Option<&super::super::super::super::objects::api::Token>,
1585    ) -> Result<
1586        super::super::super::super::objects::scout::catalog::DatasetFilesPage,
1587        conjure_http::private::Error,
1588    >;
1589    #[endpoint(
1590        method = POST,
1591        path = "/catalog/v1/search-dataset-files",
1592        name = "searchDatasetFiles",
1593        accept = conjure_http::client::StdResponseDeserializer
1594    )]
1595    async fn search_dataset_files(
1596        &self,
1597        #[auth]
1598        auth_: &conjure_object::BearerToken,
1599        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1600        request: &super::super::super::super::objects::scout::catalog::SearchDatasetFilesRequest,
1601    ) -> Result<
1602        super::super::super::super::objects::scout::catalog::SearchDatasetFilesResponse,
1603        conjure_http::private::Error,
1604    >;
1605    #[endpoint(
1606        method = GET,
1607        path = "/catalog/v1/datasets/{datasetRid}/{fileId}/uri",
1608        name = "getDatasetFileUri",
1609        accept = conjure_http::client::StdResponseDeserializer
1610    )]
1611    async fn get_dataset_file_uri(
1612        &self,
1613        #[auth]
1614        auth_: &conjure_object::BearerToken,
1615        #[path(
1616            name = "datasetRid",
1617            encoder = conjure_http::client::conjure::PlainEncoder
1618        )]
1619        dataset_rid: &super::super::super::super::objects::api::rids::DatasetRid,
1620        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1621        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1622    ) -> Result<
1623        super::super::super::super::objects::scout::catalog::DatasetFileUri,
1624        conjure_http::private::Error,
1625    >;
1626    #[endpoint(
1627        method = GET,
1628        path = "/catalog/v1/videos/{videoFileRid}/uri",
1629        name = "getVideoFileUri",
1630        accept = conjure_http::client::StdResponseDeserializer
1631    )]
1632    async fn get_video_file_uri(
1633        &self,
1634        #[auth]
1635        auth_: &conjure_object::BearerToken,
1636        #[path(
1637            name = "videoFileRid",
1638            encoder = conjure_http::client::conjure::PlainEncoder
1639        )]
1640        video_file_rid: &super::super::super::super::objects::api::rids::VideoFileRid,
1641    ) -> Result<
1642        super::super::super::super::objects::scout::catalog::VideoFileUri,
1643        conjure_http::private::Error,
1644    >;
1645    #[endpoint(
1646        method = GET,
1647        path = "/catalog/v1/datasets/{datasetRid}/{fileId}/origin-uris",
1648        name = "getOriginFileUris",
1649        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1650    )]
1651    async fn get_origin_file_uris(
1652        &self,
1653        #[auth]
1654        auth_: &conjure_object::BearerToken,
1655        #[path(
1656            name = "datasetRid",
1657            encoder = conjure_http::client::conjure::PlainEncoder
1658        )]
1659        dataset_rid: &super::super::super::super::objects::api::rids::DatasetRid,
1660        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1661        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1662    ) -> Result<
1663        Vec<super::super::super::super::objects::scout::catalog::OriginFileUri>,
1664        conjure_http::private::Error,
1665    >;
1666    #[endpoint(
1667        method = PUT,
1668        path = "/catalog/v1/datasets/{datasetRid}/file/{fileId}/success",
1669        name = "markFileIngestSuccessful",
1670        accept = conjure_http::client::StdResponseDeserializer
1671    )]
1672    async fn mark_file_ingest_successful(
1673        &self,
1674        #[auth]
1675        auth_: &conjure_object::BearerToken,
1676        #[path(
1677            name = "datasetRid",
1678            encoder = conjure_http::client::conjure::PlainEncoder
1679        )]
1680        dataset_rid: &conjure_object::ResourceIdentifier,
1681        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1682        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1683        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1684        request: &super::super::super::super::objects::scout::catalog::MarkFileIngestSuccessful,
1685    ) -> Result<
1686        super::super::super::super::objects::scout::catalog::DatasetFile,
1687        conjure_http::private::Error,
1688    >;
1689    #[endpoint(
1690        method = PUT,
1691        path = "/catalog/v1/datasets/{datasetRid}/file/{fileId}/error",
1692        name = "markFileIngestError",
1693        accept = conjure_http::client::StdResponseDeserializer
1694    )]
1695    async fn mark_file_ingest_error(
1696        &self,
1697        #[auth]
1698        auth_: &conjure_object::BearerToken,
1699        #[path(
1700            name = "datasetRid",
1701            encoder = conjure_http::client::conjure::PlainEncoder
1702        )]
1703        dataset_rid: &conjure_object::ResourceIdentifier,
1704        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1705        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1706        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1707        request: &super::super::super::super::objects::scout::catalog::MarkFileIngestError,
1708    ) -> Result<
1709        super::super::super::super::objects::scout::catalog::DatasetFile,
1710        conjure_http::private::Error,
1711    >;
1712    /// Updates file-type-specific metadata for a dataset file. Currently used to update video segment metadata
1713    /// after video segmentation is complete.
1714    #[endpoint(
1715        method = PUT,
1716        path = "/catalog/v1/datasets/{datasetRid}/file/{fileId}/metadata",
1717        name = "updateDatasetFileMetadata",
1718        accept = conjure_http::client::StdResponseDeserializer
1719    )]
1720    async fn update_dataset_file_metadata(
1721        &self,
1722        #[auth]
1723        auth_: &conjure_object::BearerToken,
1724        #[path(
1725            name = "datasetRid",
1726            encoder = conjure_http::client::conjure::PlainEncoder
1727        )]
1728        dataset_rid: &super::super::super::super::objects::api::rids::DatasetRid,
1729        #[path(name = "fileId", encoder = conjure_http::client::conjure::PlainEncoder)]
1730        file_id: super::super::super::super::objects::datasource::DatasetFileId,
1731        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1732        metadata: &super::super::super::super::objects::scout::catalog::DatasetFileMetadata,
1733    ) -> Result<
1734        super::super::super::super::objects::scout::catalog::DatasetFile,
1735        conjure_http::private::Error,
1736    >;
1737    #[endpoint(
1738        method = PUT,
1739        path = "/catalog/v1/datasets/{datasetRid}",
1740        name = "updateDatasetMetadata",
1741        accept = conjure_http::client::StdResponseDeserializer
1742    )]
1743    async fn update_dataset_metadata(
1744        &self,
1745        #[auth]
1746        auth_: &conjure_object::BearerToken,
1747        #[path(
1748            name = "datasetRid",
1749            encoder = conjure_http::client::conjure::PlainEncoder
1750        )]
1751        dataset_rid: &conjure_object::ResourceIdentifier,
1752        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1753        request: &super::super::super::super::objects::scout::catalog::UpdateDatasetMetadata,
1754    ) -> Result<
1755        super::super::super::super::objects::scout::catalog::EnrichedDataset,
1756        conjure_http::private::Error,
1757    >;
1758    /// Update the bounds for a dataset without updating bounds of files within the dataset. If the
1759    /// current bounds of the dataset are not set, then the bounds of the request will be used. Otherwise,
1760    /// the bounds will be min(current start, request start), max(current end, request end).
1761    #[endpoint(
1762        method = PUT,
1763        path = "/catalog/v1/datasets/{rid}/bounds-from-streaming",
1764        name = "updateGlobalDatasetBounds",
1765        accept = conjure_http::client::StdResponseDeserializer
1766    )]
1767    async fn update_global_dataset_bounds(
1768        &self,
1769        #[auth]
1770        auth_: &conjure_object::BearerToken,
1771        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
1772        rid: &conjure_object::ResourceIdentifier,
1773        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1774        request: &super::super::super::super::objects::scout::catalog::UpdateBoundsRequest,
1775    ) -> Result<
1776        super::super::super::super::objects::scout::catalog::Dataset,
1777        conjure_http::private::Error,
1778    >;
1779    /// Archives a dataset, which will hide it from search results unless the includeArchived flag is set to true. The
1780    /// dataset can still be directly accessed by its UUID/rid.
1781    #[endpoint(
1782        method = POST,
1783        path = "/catalog/v1/datasets/{datasetRid}/archive",
1784        name = "archiveDataset",
1785        accept = conjure_http::client::conjure::EmptyResponseDeserializer
1786    )]
1787    async fn archive_dataset(
1788        &self,
1789        #[auth]
1790        auth_: &conjure_object::BearerToken,
1791        #[path(
1792            name = "datasetRid",
1793            encoder = conjure_http::client::conjure::PlainEncoder
1794        )]
1795        dataset_rid: &conjure_object::ResourceIdentifier,
1796    ) -> Result<(), conjure_http::private::Error>;
1797    /// Undoes the archiving of a dataset.
1798    #[endpoint(
1799        method = POST,
1800        path = "/catalog/v1/datasets/{datasetRid}/unarchive",
1801        name = "unarchiveDataset",
1802        accept = conjure_http::client::conjure::EmptyResponseDeserializer
1803    )]
1804    async fn unarchive_dataset(
1805        &self,
1806        #[auth]
1807        auth_: &conjure_object::BearerToken,
1808        #[path(
1809            name = "datasetRid",
1810            encoder = conjure_http::client::conjure::PlainEncoder
1811        )]
1812        dataset_rid: &conjure_object::ResourceIdentifier,
1813    ) -> Result<(), conjure_http::private::Error>;
1814    #[endpoint(
1815        method = GET,
1816        path = "/catalog/v1/datasets/all-properties-labels",
1817        name = "getAllPropertiesAndLabels",
1818        accept = conjure_http::client::StdResponseDeserializer
1819    )]
1820    async fn get_all_properties_and_labels(
1821        &self,
1822        #[auth]
1823        auth_: &conjure_object::BearerToken,
1824        #[query(
1825            name = "workspaces",
1826            encoder = conjure_http::client::conjure::PlainSeqEncoder
1827        )]
1828        workspaces: &std::collections::BTreeSet<
1829            super::super::super::super::objects::api::rids::WorkspaceRid,
1830        >,
1831    ) -> Result<
1832        super::super::super::super::objects::scout::catalog::AllPropertiesAndLabelsResponse,
1833        conjure_http::private::Error,
1834    >;
1835    /// Returns the log dataset RID for the specified workspace if configured and accessible to the caller.
1836    #[endpoint(
1837        method = GET,
1838        path = "/catalog/v1/workspaces/{workspaceRid}/log-dataset",
1839        name = "getLogDatasetForWorkspace",
1840        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1841    )]
1842    async fn get_log_dataset_for_workspace(
1843        &self,
1844        #[auth]
1845        auth_: &conjure_object::BearerToken,
1846        #[path(
1847            name = "workspaceRid",
1848            encoder = conjure_http::client::conjure::PlainEncoder
1849        )]
1850        workspace_rid: &super::super::super::super::objects::api::rids::WorkspaceRid,
1851    ) -> Result<
1852        Option<super::super::super::super::objects::api::rids::DatasetRid>,
1853        conjure_http::private::Error,
1854    >;
1855}
nominal_api/conjure/clients/scout/catalog/catalog_service.rs

nominal_api/conjure/clients/scout/catalog/
catalog_service.rs
