Trait AsyncChecklistService 

pub trait AsyncChecklistService {
    // Required methods
    fn create(
        &self,
        auth_: BearerToken,
        request: CreateChecklistRequest,
    ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send;
    fn commit(
        &self,
        auth_: BearerToken,
        checklist_rid: ChecklistRid,
        branch: Option<BranchName>,
        request: CommitChecklistRequest,
    ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send;
    fn save_working_state(
        &self,
        auth_: BearerToken,
        checklist_rid: ChecklistRid,
        branch: Option<BranchName>,
        request: SaveChecklistRequest,
    ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send;
    fn merge_to_main(
        &self,
        auth_: BearerToken,
        checklist_rid: ChecklistRid,
        request: MergeToMainRequest,
    ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send;
    fn update_data_source_ref_names(
        &self,
        auth_: BearerToken,
        checklist_rid: ChecklistRid,
        branch: Option<BranchName>,
        ref_name_updates: BTreeMap<DataSourceRefName, DataSourceRefName>,
    ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send;
    fn update_metadata(
        &self,
        auth_: BearerToken,
        rid: ChecklistRid,
        request: UpdateChecklistMetadataRequest,
    ) -> impl Future<Output = Result<ChecklistMetadata, Error>> + Send;
    fn get(
        &self,
        auth_: BearerToken,
        rid: ChecklistRid,
        branch: Option<BranchName>,
        commit: Option<CommitId>,
    ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send;
    fn batch_get(
        &self,
        auth_: BearerToken,
        checklist_refs: BTreeSet<PinnedChecklistRef>,
    ) -> impl Future<Output = Result<BTreeSet<VersionedChecklist>, Error>> + Send;
    fn batch_get_metadata(
        &self,
        auth_: BearerToken,
        request: BatchGetChecklistMetadataRequest,
    ) -> impl Future<Output = Result<BatchGetChecklistMetadataResponse, Error>> + Send;
    fn search(
        &self,
        auth_: BearerToken,
        request: SearchChecklistsRequest,
    ) -> impl Future<Output = Result<VersionedChecklistPage, Error>> + Send;
    fn archive(
        &self,
        auth_: BearerToken,
        request: ArchiveChecklistsRequest,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn unarchive(
        &self,
        auth_: BearerToken,
        request: UnarchiveChecklistsRequest,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn get_check(
        &self,
        auth_: BearerToken,
        rid: CheckRid,
    ) -> impl Future<Output = Result<Check, Error>> + Send;
    fn batch_get_checks(
        &self,
        auth_: BearerToken,
        rids: BTreeSet<CheckRid>,
    ) -> impl Future<Output = Result<BTreeSet<Check>, Error>> + Send;
    fn get_all_labels_and_properties(
        &self,
        auth_: BearerToken,
        workspaces: BTreeSet<WorkspaceRid>,
    ) -> impl Future<Output = Result<GetAllLabelsAndPropertiesResponse, Error>> + Send;
}

The Checklist Service is responsible for managing checklists and checks. A checklist is a collection of checks that can be executed against a set of data sources.

Required Methods

fn create( &self, auth_: BearerToken, request: CreateChecklistRequest, ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send

Creates a new checklist with the provided checks.

fn commit( &self, auth_: BearerToken, checklist_rid: ChecklistRid, branch: Option<BranchName>, request: CommitChecklistRequest, ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send

Creates a permanent commit with a commit message. Throws if the checklist or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you commit to an archived checklist.

fn save_working_state( &self, auth_: BearerToken, checklist_rid: ChecklistRid, branch: Option<BranchName>, request: SaveChecklistRequest, ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send

Creates a commit that may be compacted, e.g cleaned up and not exist anymore. Throws if the checklist or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you save to an archived checklist.

fn merge_to_main( &self, auth_: BearerToken, checklist_rid: ChecklistRid, request: MergeToMainRequest, ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send

Merges the given branch to the “main” branch. Throws if the checklist or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you merge with an archived checklist.

fn update_data_source_ref_names( &self, auth_: BearerToken, checklist_rid: ChecklistRid, branch: Option<BranchName>, ref_name_updates: BTreeMap<DataSourceRefName, DataSourceRefName>, ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send

Updates the data source ref names for all checks within a checklist. Throws if the checklist doesn’t exist.

fn update_metadata( &self, auth_: BearerToken, rid: ChecklistRid, request: UpdateChecklistMetadataRequest, ) -> impl Future<Output = Result<ChecklistMetadata, Error>> + Send

Updates the metadata of a checklist.

fn get( &self, auth_: BearerToken, rid: ChecklistRid, branch: Option<BranchName>, commit: Option<CommitId>, ) -> impl Future<Output = Result<VersionedChecklist, Error>> + Send

Specify at most one of (branch, commit). If neither is specified, branch = “main” is the default.

fn batch_get( &self, auth_: BearerToken, checklist_refs: BTreeSet<PinnedChecklistRef>, ) -> impl Future<Output = Result<BTreeSet<VersionedChecklist>, Error>> + Send

Returns the pinned commit for each provided checklist reference.

fn batch_get_metadata( &self, auth_: BearerToken, request: BatchGetChecklistMetadataRequest, ) -> impl Future<Output = Result<BatchGetChecklistMetadataResponse, Error>> + Send

Returns the metadata for each provided checklist.

fn search( &self, auth_: BearerToken, request: SearchChecklistsRequest, ) -> impl Future<Output = Result<VersionedChecklistPage, Error>> + Send

Results will be the latest commit on main for each checklist.

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

Archives the provided checklists.

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

Unarchives the provided checklists.

fn get_check( &self, auth_: BearerToken, rid: CheckRid, ) -> impl Future<Output = Result<Check, Error>> + Send

Returns the check with the given rid.

fn batch_get_checks( &self, auth_: BearerToken, rids: BTreeSet<CheckRid>, ) -> impl Future<Output = Result<BTreeSet<Check>, Error>> + Send

Returns the checks with the given rids.

fn get_all_labels_and_properties( &self, auth_: BearerToken, workspaces: BTreeSet<WorkspaceRid>, ) -> impl Future<Output = Result<GetAllLabelsAndPropertiesResponse, Error>> + Send

Returns all labels and properties.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors