Trait RunService

pub trait RunService {
    // Required methods
    fn create_run(
        &self,
        auth_: BearerToken,
        details: CreateRunRequest,
    ) -> Result<Run, Error>;
    fn update_run(
        &self,
        auth_: BearerToken,
        rid: RunRid,
        details: UpdateRunRequest,
    ) -> Result<Run, Error>;
    fn add_data_sources_to_run(
        &self,
        auth_: BearerToken,
        run_rid: RunRid,
        request: BTreeMap<DataSourceRefName, CreateRunDataSource>,
    ) -> Result<Run, Error>;
    fn create_or_update_run(
        &self,
        auth_: BearerToken,
        details: CreateOrUpdateRunRequest,
    ) -> Result<Run, Error>;
    fn get_run(&self, auth_: BearerToken, rid: RunRid) -> Result<Run, Error>;
    fn get_run_with_data_review_metrics(
        &self,
        auth_: BearerToken,
        rid: RunRid,
    ) -> Result<RunWithDataReviewMetrics, Error>;
    fn get_run_with_data_review_summary(
        &self,
        auth_: BearerToken,
        rid: RunRid,
    ) -> Result<RunWithDataReviewSummary, Error>;
    fn get_run_by_id(
        &self,
        auth_: BearerToken,
        get_run_by_id_request: GetRunByIdRequest,
    ) -> Result<Run, Error>;
    fn get_runs(
        &self,
        auth_: BearerToken,
        rids: BTreeSet<RunRid>,
    ) -> Result<BTreeMap<RunRid, Run>, Error>;
    fn get_runs_by_asset(
        &self,
        auth_: BearerToken,
        request: GetRunsByAssetRequest,
    ) -> Result<GetRunsByAssetResponse, Error>;
    fn get_all_runs_properties_and_labels(
        &self,
        auth_: BearerToken,
        workspaces: BTreeSet<WorkspaceRid>,
    ) -> Result<AllRunsPropertiesAndLabelsResponse, Error>;
    fn search_runs(
        &self,
        auth_: BearerToken,
        request: SearchRunsRequest,
    ) -> Result<SearchRunsResponse, Error>;
    fn search_runs_with_data_review_metrics(
        &self,
        auth_: BearerToken,
        request: SearchRunsRequest,
    ) -> Result<SearchRunsWithDataReviewMetricsResponse, Error>;
    fn search_runs_with_data_review_summary(
        &self,
        auth_: BearerToken,
        request: SearchRunsRequest,
    ) -> Result<SearchRunsWithDataReviewSummaryResponse, Error>;
    fn archive_run(
        &self,
        auth_: BearerToken,
        rid: RunRid,
    ) -> Result<bool, Error>;
    fn unarchive_run(
        &self,
        auth_: BearerToken,
        rid: RunRid,
    ) -> Result<bool, Error>;
    fn get_data_source_ref_name_and_type_list(
        &self,
        auth_: BearerToken,
        workspaces: BTreeSet<WorkspaceRid>,
    ) -> Result<Vec<RefNameAndType>, Error>;
    fn search_channels(
        &self,
        auth_: BearerToken,
        rid: RunRid,
        request: SearchRunChannelsRequest,
    ) -> Result<SearchRunChannelsResponse, Error>;
    fn update_run_attachment(
        &self,
        auth_: BearerToken,
        rid: RunRid,
        request: UpdateAttachmentsRequest,
    ) -> Result<(), Error>;
}

Runs are collections of channels and metadata from one or more data sources, synchronized over a range of real time, which represents a test event or simulation. These API endpoints let you manage runs in the Nominal app.

Required Methods

fn create_run( &self, auth_: BearerToken, details: CreateRunRequest, ) -> Result<Run, Error>

Create a new run in Nominal.

Throws if start is equal to or after end.

fn update_run( &self, auth_: BearerToken, rid: RunRid, details: UpdateRunRequest, ) -> Result<Run, Error>

Updates an existing run based on its RID.

Throws if start is equal to or after end.

fn add_data_sources_to_run( &self, auth_: BearerToken, run_rid: RunRid, request: BTreeMap<DataSourceRefName, CreateRunDataSource>, ) -> Result<Run, Error>

Adds datasources to the run in question.

Throws if any of the ref names conflict with existing data sources or each other.

fn create_or_update_run( &self, auth_: BearerToken, details: CreateOrUpdateRunRequest, ) -> Result<Run, Error>

Updates a run if it exists, otherwise it’s created from scratch. Will throw if the workspace of an existing run is different from the workspace of the request.

fn get_run(&self, auth_: BearerToken, rid: RunRid) -> Result<Run, Error>

Fetches details about the run in question based on its RID.

fn get_run_with_data_review_metrics( &self, auth_: BearerToken, rid: RunRid, ) -> Result<RunWithDataReviewMetrics, Error>

Fetches details about the run in question based on its RID, including metrics for check and violation review status.

fn get_run_with_data_review_summary( &self, auth_: BearerToken, rid: RunRid, ) -> Result<RunWithDataReviewSummary, Error>

Fetches details about the run in question based on its RID, including a summary of the data review status.

fn get_run_by_id( &self, auth_: BearerToken, get_run_by_id_request: GetRunByIdRequest, ) -> Result<Run, Error>

Fetches a run based on the run number, rather than RID.

fn get_runs( &self, auth_: BearerToken, rids: BTreeSet<RunRid>, ) -> Result<BTreeMap<RunRid, Run>, Error>

Fetches a list of run details based on a list of RIDs.

fn get_runs_by_asset( &self, auth_: BearerToken, request: GetRunsByAssetRequest, ) -> Result<GetRunsByAssetResponse, Error>

Fetches the runs with the given asset.

fn get_all_runs_properties_and_labels( &self, auth_: BearerToken, workspaces: BTreeSet<WorkspaceRid>, ) -> Result<AllRunsPropertiesAndLabelsResponse, Error>

fn search_runs( &self, auth_: BearerToken, request: SearchRunsRequest, ) -> Result<SearchRunsResponse, Error>

Searches for runs that match the given filters.

fn search_runs_with_data_review_metrics( &self, auth_: BearerToken, request: SearchRunsRequest, ) -> Result<SearchRunsWithDataReviewMetricsResponse, Error>

Searches for runs that match the given filters and includes metrics for check and violation review status.

fn search_runs_with_data_review_summary( &self, auth_: BearerToken, request: SearchRunsRequest, ) -> Result<SearchRunsWithDataReviewSummaryResponse, Error>

Searches for runs that match the given filters and includes a summary of the data review status.

fn archive_run(&self, auth_: BearerToken, rid: RunRid) -> Result<bool, Error>

Soft-deletes a run. Runs still exist in the database but are no longer visible.

fn unarchive_run(&self, auth_: BearerToken, rid: RunRid) -> Result<bool, Error>

fn get_data_source_ref_name_and_type_list( &self, auth_: BearerToken, workspaces: BTreeSet<WorkspaceRid>, ) -> Result<Vec<RefNameAndType>, Error>

Returns the list of ref names that are in use across specified and authorized workspaces.

fn search_channels( &self, auth_: BearerToken, rid: RunRid, request: SearchRunChannelsRequest, ) -> Result<SearchRunChannelsResponse, Error>

fn update_run_attachment( &self, auth_: BearerToken, rid: RunRid, request: UpdateAttachmentsRequest, ) -> Result<(), Error>

Updates the attachments associated with a run.

Implementors