Trait IngestService

pub trait IngestService {
    // Required methods
    fn ingest(
        &self,
        auth_: BearerToken,
        trigger_ingest: IngestRequest,
    ) -> Result<IngestResponse, Error>;
    fn deprecated_trigger_ingest(
        &self,
        auth_: BearerToken,
        trigger_ingest: DeprecatedTriggerIngest,
    ) -> Result<TriggeredIngest, Error>;
    fn trigger_ingest(
        &self,
        auth_: BearerToken,
        trigger_ingest: TriggerIngest,
    ) -> Result<TriggeredIngest, Error>;
    fn trigger_file_ingest(
        &self,
        auth_: BearerToken,
        trigger_ingest: TriggerFileIngest,
    ) -> Result<TriggeredIngest, Error>;
    fn ingest_run(
        &self,
        auth_: BearerToken,
        request: IngestRunRequest,
    ) -> Result<IngestRunResponse, Error>;
    fn ingest_video(
        &self,
        auth_: BearerToken,
        ingest_video: IngestVideoRequest,
    ) -> Result<IngestVideoResponse, Error>;
    fn ingest_mcap(
        &self,
        auth_: BearerToken,
        ingest_video: IngestMcapRequest,
    ) -> Result<IngestMcapResponse, Error>;
}

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

Required Methods

fn ingest( &self, auth_: BearerToken, trigger_ingest: IngestRequest, ) -> Result<IngestResponse, Error>

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

fn trigger_ingest( &self, auth_: BearerToken, trigger_ingest: TriggerIngest, ) -> Result<TriggeredIngest, Error>

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

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

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

fn ingest_video( &self, auth_: BearerToken, ingest_video: IngestVideoRequest, ) -> Result<IngestVideoResponse, Error>

Ingests video data from a S3 Nominal upload bucket.

fn ingest_mcap( &self, auth_: BearerToken, ingest_video: IngestMcapRequest, ) -> Result<IngestMcapResponse, Error>

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

Implementors