Skip to main content

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