Struct IngestServiceAsyncClient

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

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

Implementations

impl<T> IngestServiceAsyncClient<T>

where T: AsyncClient,

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

pub async fn deprecated_trigger_ingest( &self, auth_: &BearerToken, trigger_ingest: &DeprecatedTriggerIngest, ) -> Result<TriggeredIngest, Error>

👎Deprecated: Replaced by ingest.

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

👎Deprecated: Replaced by ingest.

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

pub async fn trigger_file_ingest( &self, auth_: &BearerToken, trigger_ingest: &TriggerFileIngest, ) -> Result<TriggeredIngest, Error>

👎Deprecated: Replaced by ingest.

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

pub async fn ingest_run( &self, auth_: &BearerToken, request: &IngestRunRequest, ) -> Result<IngestRunResponse, Error>

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

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

👎Deprecated: Replaced by ingest.

Ingests video data from a S3 Nominal upload bucket.

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

👎Deprecated: Replaced by ingest.

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

pub async fn reingest_from_datasets( &self, auth_: &BearerToken, request: &ReingestDatasetsRequest, ) -> Result<ReingestDatasetsResponse, Error>

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.

pub async fn delete_file( &self, auth_: &BearerToken, dataset_rid: &DatasetRid, file_id: Uuid, ) -> Result<(), Error>

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.

Trait Implementations

impl<T> AsyncService<T> for IngestServiceAsyncClient<T>

where T: AsyncClient,

fn new(client: T) -> Self

Creates a new service wrapping an async HTTP client.

impl<T: Clone> Clone for IngestServiceAsyncClient<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for IngestServiceAsyncClient<T>

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

Formats the value using the given formatter.