nominal_api::scout::checklistexecution::api

Trait ChecklistExecutionService

Source 
pub trait ChecklistExecutionService {
    // Required methods
    fn checklist_live_status(
        &self,
        auth_: BearerToken,
        request: BatchChecklistLiveStatusRequest,
    ) -> Result<BatchChecklistLiveStatusResponse, Error>;
    fn execute_streaming_checklist(
        &self,
        auth_: BearerToken,
        request: ExecuteChecklistForAssetsRequest,
    ) -> Result<(), Error>;
    fn list_streaming_checklist(
        &self,
        auth_: BearerToken,
        request: ListStreamingChecklistRequest,
    ) -> Result<ListStreamingChecklistResponse, Error>;
    fn list_streaming_checklist_for_asset(
        &self,
        auth_: BearerToken,
        request: ListStreamingChecklistForAssetRequest,
    ) -> Result<ListStreamingChecklistForAssetResponse, Error>;
    fn get_streaming_checklist(
        &self,
        auth_: BearerToken,
        checklist_rid: ChecklistRid,
    ) -> Result<StreamingChecklistInfo, Error>;
    fn stop_streaming_checklist(
        &self,
        auth_: BearerToken,
        checklist_rid: ChecklistRid,
    ) -> Result<(), Error>;
    fn stop_streaming_checklist_for_assets(
        &self,
        auth_: BearerToken,
        request: StopStreamingChecklistForAssetsRequest,
    ) -> Result<(), Error>;
    fn reload_streaming_checklist(
        &self,
        auth_: BearerToken,
        checklist_rid: ChecklistRid,
    ) -> Result<(), Error>;
    fn validate_checklist_resolution(
        &self,
        auth_: BearerToken,
        request: BatchValidateChecklistResolutionRequest,
    ) -> Result<BatchValidateChecklistResolutionResponse, Error>;
}
Expand description

The Checklist Execution Service checks the status of checklist executions.

Required Methods§

Source

fn checklist_live_status( &self, auth_: BearerToken, request: BatchChecklistLiveStatusRequest, ) -> Result<BatchChecklistLiveStatusResponse, Error>

For each request, get the current status and last failing time (if possible) for every automatic check against the given run.

Source

fn execute_streaming_checklist( &self, auth_: BearerToken, request: ExecuteChecklistForAssetsRequest, ) -> Result<(), Error>

Triggers a checklist to run continuously against assets. Returns a ChecklistAlreadyRunning error if the checklist is already running for the given asset.

Source

fn list_streaming_checklist( &self, auth_: BearerToken, request: ListStreamingChecklistRequest, ) -> Result<ListStreamingChecklistResponse, Error>

Lists all running streaming checklists.

Source

fn list_streaming_checklist_for_asset( &self, auth_: BearerToken, request: ListStreamingChecklistForAssetRequest, ) -> Result<ListStreamingChecklistForAssetResponse, Error>

Retrieves all streaming checklists for a given asset.

Source

fn get_streaming_checklist( &self, auth_: BearerToken, checklist_rid: ChecklistRid, ) -> Result<StreamingChecklistInfo, Error>

Retrieves information about a streaming checklist using the provided checklistRid.

Source

fn stop_streaming_checklist( &self, auth_: BearerToken, checklist_rid: ChecklistRid, ) -> Result<(), Error>

Stops the execution of a streaming checklist on all assets.

Source

fn stop_streaming_checklist_for_assets( &self, auth_: BearerToken, request: StopStreamingChecklistForAssetsRequest, ) -> Result<(), Error>

Stops the execution of a streaming checklist for a given set of assets.

Source

fn reload_streaming_checklist( &self, auth_: BearerToken, checklist_rid: ChecklistRid, ) -> Result<(), Error>

Reloads the state of the streaming checklist for the given checklistRid.

Source

fn validate_checklist_resolution( &self, auth_: BearerToken, request: BatchValidateChecklistResolutionRequest, ) -> Result<BatchValidateChecklistResolutionResponse, Error>

Validates that the channels referenced by the checklist can be resolved against the data sources.

Implementors§