Struct CatalogServiceAsyncClient

pub struct CatalogServiceAsyncClient<T>(/* private fields */);

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.

Implementations

impl<T> CatalogServiceAsyncClient<T>

where T: AsyncClient,

pub async fn get_enriched_dataset( &self, auth_: &BearerToken, dataset_uuid: Uuid, ) -> Result<EnrichedDataset, Error>

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

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

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

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

pub async fn search_datasets_by_text( &self, auth_: &BearerToken, request: &SearchDatasetsByTextRequest, ) -> Result<SearchDatasetsByTextResponse, Error>

👎Deprecated: Deprecated in favor of searchDatasets

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

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

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

👎Deprecated: Deprecated in favor of getDatasetFile.

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

👎Deprecated: Returned in Dataset

pub async fn get_series_details( &self, auth_: &BearerToken, get_series_details: &GetSeriesDetailsRequest, ) -> Result<SeriesDetails, Error>

👎Deprecated: Deprecated in favor of DataSourceService#getChannels

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

pub async 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

pub async fn add_file_to_dataset( &self, auth_: &BearerToken, dataset_rid: &ResourceIdentifier, request: &AddFileToDataset, ) -> Result<DatasetFile, Error>

Adds a single file to an existing dataset.

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

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

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

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

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

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

pub async fn delete_dataset_series( &self, auth_: &BearerToken, dataset_rid: &ResourceIdentifier, ) -> Result<DeleteSeriesResult, Error>

pub async 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.

pub async fn unarchive_dataset( &self, auth_: &BearerToken, dataset_rid: &ResourceIdentifier, ) -> Result<(), Error>

Undoes the archiving of a dataset.

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

Trait Implementations

impl<T> AsyncService<T> for CatalogServiceAsyncClient<T>

where T: AsyncClient,

fn new(client: T) -> Self

Creates a new service wrapping an async HTTP client.

impl<T: Clone> Clone for CatalogServiceAsyncClient<T>

fn clone(&self) -> CatalogServiceAsyncClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for CatalogServiceAsyncClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.