Struct IngestServiceClient

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

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

Implementations

impl<T> IngestServiceClient<T>

where T: Client,

pub 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 fn deprecated_trigger_ingest( &self, auth_: &BearerToken, trigger_ingest: &DeprecatedTriggerIngest, ) -> Result<TriggeredIngest, Error>

👎Deprecated: Replaced by ingest.

pub 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 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 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 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 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 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 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: Clone> Clone for IngestServiceClient<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for IngestServiceClient<T>

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

Formats the value using the given formatter.

impl<T> Service<T> for IngestServiceClient<T>

where T: Client,

fn new(client: T) -> Self

Creates a new service wrapping an HTTP client.