Trait CatalogService 

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

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, ) -> Result<EnrichedDataset, Error>

fn get_enriched_datasets( &self, auth_: BearerToken, get_datasets_request: GetDatasetsRequest, ) -> Result<BTreeSet<EnrichedDataset>, Error>

fn get_dataset( &self, auth_: BearerToken, dataset_uuid: Uuid, ) -> Result<Dataset, Error>

fn get_datasets( &self, auth_: BearerToken, get_datasets_request: GetDatasetsRequest, ) -> Result<BTreeSet<Dataset>, Error>

fn get_dataset_file( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, file_id: DatasetFileId, ) -> Result<DatasetFile, Error>

fn get_dataset_files_for_job( &self, auth_: BearerToken, ingest_job_rid: ResourceIdentifier, next_page_token: Option<Token>, ) -> Result<DatasetFilesPage, Error>

fn search_datasets( &self, auth_: BearerToken, request: SearchDatasetsRequest, ) -> Result<SearchDatasetsResponse, Error>

fn update_dataset_ingest_status_v2( &self, auth_: BearerToken, details: UpdateIngestStatusV2, ) -> Result<IngestStatusV2, Error>

fn get_ingest_progress_v2( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, ) -> Result<IngestProgressV2, Error>

fn get_handle_for_dataset( &self, auth_: BearerToken, dataset: Uuid, ) -> Result<Option<Handle>, Error>

fn create_dataset( &self, auth_: BearerToken, details: CreateDataset, ) -> Result<EnrichedDataset, Error>

fn create_or_update_dataset( &self, auth_: BearerToken, details: CreateDataset, ) -> Result<EnrichedDataset, Error>

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, ) -> Result<DatasetFile, Error>

Adds a single file to an existing dataset.

fn list_dataset_files( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, next_page_token: Option<Token>, ) -> Result<DatasetFilesPage, Error>

fn search_dataset_files( &self, auth_: BearerToken, request: SearchDatasetFilesRequest, ) -> Result<SearchDatasetFilesResponse, Error>

fn get_dataset_file_uri( &self, auth_: BearerToken, dataset_rid: DatasetRid, file_id: DatasetFileId, ) -> Result<DatasetFileUri, Error>

fn get_origin_file_uris( &self, auth_: BearerToken, dataset_rid: DatasetRid, file_id: DatasetFileId, ) -> Result<Vec<OriginFileUri>, Error>

fn mark_file_ingest_successful( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, file_id: DatasetFileId, request: MarkFileIngestSuccessful, ) -> Result<DatasetFile, Error>

fn mark_file_ingest_error( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, file_id: DatasetFileId, request: MarkFileIngestError, ) -> Result<DatasetFile, Error>

fn update_dataset_metadata( &self, auth_: BearerToken, dataset_rid: ResourceIdentifier, request: UpdateDatasetMetadata, ) -> Result<EnrichedDataset, Error>

fn update_bounds( &self, auth_: BearerToken, rid: ResourceIdentifier, request: UpdateBoundsRequest, ) -> Result<EnrichedDataset, Error>

fn update_global_dataset_bounds( &self, auth_: BearerToken, rid: ResourceIdentifier, request: UpdateBoundsRequest, ) -> Result<Dataset, Error>

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, ) -> Result<(), Error>

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, ) -> Result<(), Error>

Undoes the archiving of a dataset.

fn get_all_properties_and_labels( &self, auth_: BearerToken, workspaces: BTreeSet<WorkspaceRid>, ) -> Result<AllPropertiesAndLabelsResponse, Error>

fn get_log_dataset_for_workspace( &self, auth_: BearerToken, workspace_rid: WorkspaceRid, ) -> Result<Option<DatasetRid>, Error>

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

Implementors