Skip to main content

IngestJobService

Trait IngestJobService 

Source
pub trait IngestJobService<I>
where I: Iterator<Item = Result<Bytes, Error>>,
{ // Required methods fn get_ingest_job( &self, auth_: &BearerToken, ingest_job_rid: &ResourceIdentifier, ) -> Result<IngestJob, Error>; fn search_ingest_jobs( &self, auth_: &BearerToken, request: &SearchIngestJobsRequest, ) -> Result<SearchIngestJobsResponse, Error>; fn cancel_ingest_job( &self, auth_: &BearerToken, ingest_job_rid: &ResourceIdentifier, ) -> Result<IngestJob, Error>; }
Expand description

Public API for querying ingest jobs.

Required Methods§

Source

fn get_ingest_job( &self, auth_: &BearerToken, ingest_job_rid: &ResourceIdentifier, ) -> Result<IngestJob, Error>

Returns a single ingest job by RID. Does not include the full ingest request details.

Source

fn search_ingest_jobs( &self, auth_: &BearerToken, request: &SearchIngestJobsRequest, ) -> Result<SearchIngestJobsResponse, Error>

Returns a paginated list of ingest jobs, optionally filtered by dataset.

Source

fn cancel_ingest_job( &self, auth_: &BearerToken, ingest_job_rid: &ResourceIdentifier, ) -> Result<IngestJob, Error>

Cancels an ingest job. Jobs that have not yet started running (SUBMITTED, QUEUED) are transitioned directly to CANCELLED. Jobs that are IN_PROGRESS have their underlying Temporal workflow cancelled; the workflow is responsible for transitioning the job to CANCELLED and tearing down in-flight work. Cancelling a job that is already in a terminal state (COMPLETED, FAILED, CANCELLED) throws IngestJobNotCancellable.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§

Source§

impl<I, __C> IngestJobService<I> for IngestJobServiceClient<__C>
where I: Iterator<Item = Result<Bytes, Error>>, __C: Client<ResponseBody = I>,