Skip to main content

AsyncIngestJobService

Trait AsyncIngestJobService 

Source
pub trait AsyncIngestJobService {
    // Required methods
    fn get_ingest_job(
        &self,
        auth_: BearerToken,
        ingest_job_rid: ResourceIdentifier,
    ) -> impl Future<Output = Result<IngestJob, Error>> + Send;
    fn get_ingest_transform(
        &self,
        auth_: BearerToken,
        ingest_transform_rid: ResourceIdentifier,
    ) -> impl Future<Output = Result<IngestTransform, Error>> + Send;
    fn search_ingest_transforms(
        &self,
        auth_: BearerToken,
        request: SearchIngestTransformsRequest,
    ) -> impl Future<Output = Result<SearchIngestTransformsResponse, Error>> + Send;
    fn search_ingest_jobs(
        &self,
        auth_: BearerToken,
        request: SearchIngestJobsRequest,
    ) -> impl Future<Output = Result<SearchIngestJobsResponse, Error>> + Send;
    fn cancel_ingest_job(
        &self,
        auth_: BearerToken,
        ingest_job_rid: ResourceIdentifier,
    ) -> impl Future<Output = Result<IngestJob, Error>> + Send;
    fn batch_cancel_ingest_jobs(
        &self,
        auth_: BearerToken,
        request: BatchCancelIngestJobsRequest,
    ) -> impl Future<Output = Result<BatchCancelIngestJobsResponse, Error>> + Send;
}
Expand description

Public API for querying ingest jobs.

Required Methods§

Source

fn get_ingest_job( &self, auth_: BearerToken, ingest_job_rid: ResourceIdentifier, ) -> impl Future<Output = Result<IngestJob, Error>> + Send

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

Source

fn get_ingest_transform( &self, auth_: BearerToken, ingest_transform_rid: ResourceIdentifier, ) -> impl Future<Output = Result<IngestTransform, Error>> + Send

Returns a single ingest transform by RID. The caller must be authorized to read the dataset produced by the transform’s parent ingest job; a transform whose parent job is not visible to the caller is reported as IngestTransformNotFound rather than leaking its existence.

Source

fn search_ingest_transforms( &self, auth_: BearerToken, request: SearchIngestTransformsRequest, ) -> impl Future<Output = Result<SearchIngestTransformsResponse, Error>> + Send

Returns a paginated list of the transforms belonging to a single ingest job, oldest-first and optionally filtered by status. The caller must be authorized to read the parent job’s dataset; a job that is not visible to the caller is reported as IngestJobNotFound.

Source

fn search_ingest_jobs( &self, auth_: BearerToken, request: SearchIngestJobsRequest, ) -> impl Future<Output = Result<SearchIngestJobsResponse, Error>> + Send

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

Source

fn cancel_ingest_job( &self, auth_: BearerToken, ingest_job_rid: ResourceIdentifier, ) -> impl Future<Output = Result<IngestJob, Error>> + Send

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.

Source

fn batch_cancel_ingest_jobs( &self, auth_: BearerToken, request: BatchCancelIngestJobsRequest, ) -> impl Future<Output = Result<BatchCancelIngestJobsResponse, Error>> + Send

Cancels multiple ingest jobs in a single call. Each job is processed independently and best-effort: a job that cannot be cancelled (already terminal, missing, or not authorized for the caller) yields a failed result rather than aborting the batch. Per-job cancellation semantics match cancelIngestJob. At most 100 jobs may be requested per call.

Dyn Compatibility§

This trait is not dyn compatible.

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

Implementors§