Trait AsyncCatalogService 

pub trait AsyncCatalogService {
    // Required methods
    fn get_enriched_dataset(
        &self,
        auth_: BearerToken,
        dataset_uuid: Uuid,
    ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send;
    fn get_enriched_datasets(
        &self,
        auth_: BearerToken,
        get_datasets_request: GetDatasetsRequest,
    ) -> impl Future<Output = Result<BTreeSet<EnrichedDataset>, Error>> + Send;
    fn get_dataset(
        &self,
        auth_: BearerToken,
        dataset_uuid: Uuid,
    ) -> impl Future<Output = Result<Dataset, Error>> + Send;
    fn get_datasets(
        &self,
        auth_: BearerToken,
        get_datasets_request: GetDatasetsRequest,
    ) -> impl Future<Output = Result<BTreeSet<Dataset>, Error>> + Send;
    fn get_dataset_file(
        &self,
        auth_: BearerToken,
        dataset_rid: ResourceIdentifier,
        file_id: DatasetFileId,
    ) -> impl Future<Output = Result<DatasetFile, Error>> + Send;
    fn get_dataset_files_for_job(
        &self,
        auth_: BearerToken,
        ingest_job_rid: ResourceIdentifier,
        next_page_token: Option<Token>,
    ) -> impl Future<Output = Result<DatasetFilesPage, Error>> + Send;
    fn search_datasets(
        &self,
        auth_: BearerToken,
        request: SearchDatasetsRequest,
    ) -> impl Future<Output = Result<SearchDatasetsResponse, Error>> + Send;
    fn update_dataset_ingest_status_v2(
        &self,
        auth_: BearerToken,
        details: UpdateIngestStatusV2,
    ) -> impl Future<Output = Result<IngestStatusV2, Error>> + Send;
    fn get_ingest_progress_v2(
        &self,
        auth_: BearerToken,
        dataset_rid: ResourceIdentifier,
    ) -> impl Future<Output = Result<IngestProgressV2, Error>> + Send;
    fn get_handle_for_dataset(
        &self,
        auth_: BearerToken,
        dataset: Uuid,
    ) -> impl Future<Output = Result<Option<Handle>, Error>> + Send;
    fn create_dataset(
        &self,
        auth_: BearerToken,
        details: CreateDataset,
    ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send;
    fn create_or_update_dataset(
        &self,
        auth_: BearerToken,
        details: CreateDataset,
    ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send;
    fn add_file_to_dataset(
        &self,
        auth_: BearerToken,
        dataset_rid: ResourceIdentifier,
        request: AddFileToDataset,
    ) -> impl Future<Output = Result<DatasetFile, Error>> + Send;
    fn list_dataset_files(
        &self,
        auth_: BearerToken,
        dataset_rid: ResourceIdentifier,
        next_page_token: Option<Token>,
    ) -> impl Future<Output = Result<DatasetFilesPage, Error>> + Send;
    fn search_dataset_files(
        &self,
        auth_: BearerToken,
        request: SearchDatasetFilesRequest,
    ) -> impl Future<Output = Result<SearchDatasetFilesResponse, Error>> + Send;
    fn get_dataset_file_uri(
        &self,
        auth_: BearerToken,
        dataset_rid: DatasetRid,
        file_id: DatasetFileId,
    ) -> impl Future<Output = Result<DatasetFileUri, Error>> + Send;
    fn get_origin_file_uris(
        &self,
        auth_: BearerToken,
        dataset_rid: DatasetRid,
        file_id: DatasetFileId,
    ) -> impl Future<Output = Result<Vec<OriginFileUri>, Error>> + Send;
    fn mark_file_ingest_successful(
        &self,
        auth_: BearerToken,
        dataset_rid: ResourceIdentifier,
        file_id: DatasetFileId,
        request: MarkFileIngestSuccessful,
    ) -> impl Future<Output = Result<DatasetFile, Error>> + Send;
    fn mark_file_ingest_error(
        &self,
        auth_: BearerToken,
        dataset_rid: ResourceIdentifier,
        file_id: DatasetFileId,
        request: MarkFileIngestError,
    ) -> impl Future<Output = Result<DatasetFile, Error>> + Send;
    fn update_dataset_metadata(
        &self,
        auth_: BearerToken,
        dataset_rid: ResourceIdentifier,
        request: UpdateDatasetMetadata,
    ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send;
    fn update_bounds(
        &self,
        auth_: BearerToken,
        rid: ResourceIdentifier,
        request: UpdateBoundsRequest,
    ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send;
    fn update_global_dataset_bounds(
        &self,
        auth_: BearerToken,
        rid: ResourceIdentifier,
        request: UpdateBoundsRequest,
    ) -> impl Future<Output = Result<Dataset, Error>> + Send;
    fn archive_dataset(
        &self,
        auth_: BearerToken,
        dataset_rid: ResourceIdentifier,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn unarchive_dataset(
        &self,
        auth_: BearerToken,
        dataset_rid: ResourceIdentifier,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn get_all_properties_and_labels(
        &self,
        auth_: BearerToken,
        workspaces: BTreeSet<WorkspaceRid>,
    ) -> impl Future<Output = Result<AllPropertiesAndLabelsResponse, Error>> + Send;
    fn get_log_dataset_for_workspace(
        &self,
        auth_: BearerToken,
        workspace_rid: WorkspaceRid,
    ) -> impl Future<Output = Result<Option<DatasetRid>, Error>> + Send;
}

The Catalog Service provides the ability to query for information about Datasets that are stored in the Nominal platform. A Dataset is the Nominal representation of data that has been uploaded to Nominal via a file, primarily CSV.

Required Methods

fn get_enriched_dataset( &self, auth_: BearerToken, dataset_uuid: Uuid, ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send

fn get_enriched_datasets( &self, auth_: BearerToken, get_datasets_request: GetDatasetsRequest, ) -> impl Future<Output = Result<BTreeSet<EnrichedDataset>, Error>> + Send

fn get_dataset( &self, auth_: BearerToken, dataset_uuid: Uuid, ) -> impl Future<Output = Result<Dataset, Error>> + Send

fn get_datasets( &self, auth_: BearerToken, get_datasets_request: GetDatasetsRequest, ) -> impl Future<Output = Result<BTreeSet<Dataset>, Error>> + Send

fn get_dataset_file( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, file_id: DatasetFileId, ) -> impl Future<Output = Result<DatasetFile, Error>> + Send

fn get_dataset_files_for_job( &self, auth_: BearerToken, ingest_job_rid: ResourceIdentifier, next_page_token: Option<Token>, ) -> impl Future<Output = Result<DatasetFilesPage, Error>> + Send

fn search_datasets( &self, auth_: BearerToken, request: SearchDatasetsRequest, ) -> impl Future<Output = Result<SearchDatasetsResponse, Error>> + Send

fn update_dataset_ingest_status_v2( &self, auth_: BearerToken, details: UpdateIngestStatusV2, ) -> impl Future<Output = Result<IngestStatusV2, Error>> + Send

fn get_ingest_progress_v2( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, ) -> impl Future<Output = Result<IngestProgressV2, Error>> + Send

fn get_handle_for_dataset( &self, auth_: BearerToken, dataset: Uuid, ) -> impl Future<Output = Result<Option<Handle>, Error>> + Send

fn create_dataset( &self, auth_: BearerToken, details: CreateDataset, ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send

fn create_or_update_dataset( &self, auth_: BearerToken, details: CreateDataset, ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send

Creates a dataset if the s3 path does not exist, otherwise updates the dataset

fn add_file_to_dataset( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, request: AddFileToDataset, ) -> impl Future<Output = Result<DatasetFile, Error>> + Send

Adds a single file to an existing dataset.

fn list_dataset_files( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, next_page_token: Option<Token>, ) -> impl Future<Output = Result<DatasetFilesPage, Error>> + Send

fn search_dataset_files( &self, auth_: BearerToken, request: SearchDatasetFilesRequest, ) -> impl Future<Output = Result<SearchDatasetFilesResponse, Error>> + Send

fn get_dataset_file_uri( &self, auth_: BearerToken, dataset_rid: DatasetRid, file_id: DatasetFileId, ) -> impl Future<Output = Result<DatasetFileUri, Error>> + Send

fn get_origin_file_uris( &self, auth_: BearerToken, dataset_rid: DatasetRid, file_id: DatasetFileId, ) -> impl Future<Output = Result<Vec<OriginFileUri>, Error>> + Send

fn mark_file_ingest_successful( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, file_id: DatasetFileId, request: MarkFileIngestSuccessful, ) -> impl Future<Output = Result<DatasetFile, Error>> + Send

fn mark_file_ingest_error( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, file_id: DatasetFileId, request: MarkFileIngestError, ) -> impl Future<Output = Result<DatasetFile, Error>> + Send

fn update_dataset_metadata( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, request: UpdateDatasetMetadata, ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send

fn update_bounds( &self, auth_: BearerToken, rid: ResourceIdentifier, request: UpdateBoundsRequest, ) -> impl Future<Output = Result<EnrichedDataset, Error>> + Send

fn update_global_dataset_bounds( &self, auth_: BearerToken, rid: ResourceIdentifier, request: UpdateBoundsRequest, ) -> impl Future<Output = Result<Dataset, Error>> + Send

Update the bounds for a dataset without updating bounds of files within the dataset. If the current bounds of the dataset are not set, then the bounds of the request will be used. Otherwise, the bounds will be min(current start, request start), max(current end, request end).

fn archive_dataset( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, ) -> impl Future<Output = Result<(), Error>> + Send

Archives a dataset, which will hide it from search results unless the includeArchived flag is set to true. The dataset can still be directly accessed by its UUID/rid.

fn unarchive_dataset( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, ) -> impl Future<Output = Result<(), Error>> + Send

Undoes the archiving of a dataset.

fn get_all_properties_and_labels( &self, auth_: BearerToken, workspaces: BTreeSet<WorkspaceRid>, ) -> impl Future<Output = Result<AllPropertiesAndLabelsResponse, Error>> + Send

fn get_log_dataset_for_workspace( &self, auth_: BearerToken, workspace_rid: WorkspaceRid, ) -> impl Future<Output = Result<Option<DatasetRid>, Error>> + Send

Returns the log dataset RID for the specified workspace if configured and accessible to the caller.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors