Trait AsyncIngestService

pub trait AsyncIngestService {
    // Required methods
    fn ingest(
        &self,
        auth_: BearerToken,
        trigger_ingest: IngestRequest,
    ) -> impl Future<Output = Result<IngestResponse, Error>> + Send;
    fn deprecated_trigger_ingest(
        &self,
        auth_: BearerToken,
        trigger_ingest: DeprecatedTriggerIngest,
    ) -> impl Future<Output = Result<TriggeredIngest, Error>> + Send;
    fn trigger_ingest(
        &self,
        auth_: BearerToken,
        trigger_ingest: TriggerIngest,
    ) -> impl Future<Output = Result<TriggeredIngest, Error>> + Send;
    fn trigger_file_ingest(
        &self,
        auth_: BearerToken,
        trigger_ingest: TriggerFileIngest,
    ) -> impl Future<Output = Result<TriggeredIngest, Error>> + Send;
    fn ingest_run(
        &self,
        auth_: BearerToken,
        request: IngestRunRequest,
    ) -> impl Future<Output = Result<IngestRunResponse, Error>> + Send;
    fn ingest_video(
        &self,
        auth_: BearerToken,
        ingest_video: IngestVideoRequest,
    ) -> impl Future<Output = Result<IngestVideoResponse, Error>> + Send;
    fn ingest_mcap(
        &self,
        auth_: BearerToken,
        ingest_video: IngestMcapRequest,
    ) -> impl Future<Output = Result<IngestMcapResponse, Error>> + Send;
    fn reingest_from_datasets(
        &self,
        auth_: BearerToken,
        request: ReingestDatasetsRequest,
    ) -> impl Future<Output = Result<ReingestDatasetsResponse, Error>> + Send;
    fn delete_file(
        &self,
        auth_: BearerToken,
        dataset_rid: DatasetRid,
        file_id: Uuid,
    ) -> impl Future<Output = Result<(), Error>> + Send;
}

The Ingest Service handles the data ingestion into Nominal/Clickhouse.

Required Methods

fn ingest( &self, auth_: BearerToken, trigger_ingest: IngestRequest, ) -> impl Future<Output = Result<IngestResponse, Error>> + Send

Triggers an ingest job, allowing either creating a new dataset or uploading to an existing one. This endpoint is meant to supersede all other ingestion endpoints as their functionality gets migrated to this one.

fn deprecated_trigger_ingest( &self, auth_: BearerToken, trigger_ingest: DeprecatedTriggerIngest, ) -> impl Future<Output = Result<TriggeredIngest, Error>> + Send

fn trigger_ingest( &self, auth_: BearerToken, trigger_ingest: TriggerIngest, ) -> impl Future<Output = Result<TriggeredIngest, Error>> + Send

Triggers an ingest job for the given data source. The ingest job will be processed asynchronously.

fn trigger_file_ingest( &self, auth_: BearerToken, trigger_ingest: TriggerFileIngest, ) -> impl Future<Output = Result<TriggeredIngest, Error>> + Send

Triggers an ingest job of a new file, allowing either creating a new dataset or uploading to an existing one.

fn ingest_run( &self, auth_: BearerToken, request: IngestRunRequest, ) -> impl Future<Output = Result<IngestRunResponse, Error>> + Send

Creates a run and ingests data sources to be added to the run.

fn ingest_video( &self, auth_: BearerToken, ingest_video: IngestVideoRequest, ) -> impl Future<Output = Result<IngestVideoResponse, Error>> + Send

Ingests video data from a S3 Nominal upload bucket.

fn ingest_mcap( &self, auth_: BearerToken, ingest_video: IngestMcapRequest, ) -> impl Future<Output = Result<IngestMcapResponse, Error>> + Send

Ingests data from mcap files in the S3 Nominal upload bucket.

fn reingest_from_datasets( &self, auth_: BearerToken, request: ReingestDatasetsRequest, ) -> impl Future<Output = Result<ReingestDatasetsResponse, Error>> + Send

Re-ingests data from provided source datasets into either an existing target dataset, or a new one. Only supported for CSV and Parquet dataset files. Will only reingest dataset files and will drop streaming data from datasets.

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

This is a best effort deletion of the file’s data based on the ingestedAt timestamp. This is an unreversible action. Only v2 dataset file deletion is supported. !!!WARNING!!! It’s possible that the file has overwritten points, in which case, those older points will not be recovered. Only use this endpoint if this is acceptable, the data across files are disjoint, or you’re willing to re-ingest files to manually recover older points.

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