Struct ChecklistServiceClient 

pub struct ChecklistServiceClient<T>(/* private fields */);

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.

Implementations

impl<T> ChecklistServiceClient<T>

where T: Client,

pub fn create( &self, auth_: &BearerToken, request: &CreateChecklistRequest, ) -> Result<VersionedChecklist, Error>

Creates a new checklist with the provided checks.

pub fn commit( &self, auth_: &BearerToken, checklist_rid: &ChecklistRid, branch: Option<&BranchName>, request: &CommitChecklistRequest, ) -> Result<VersionedChecklist, Error>

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.

pub fn save_working_state( &self, auth_: &BearerToken, checklist_rid: &ChecklistRid, branch: Option<&BranchName>, request: &SaveChecklistRequest, ) -> Result<VersionedChecklist, Error>

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.

pub fn merge_to_main( &self, auth_: &BearerToken, checklist_rid: &ChecklistRid, request: &MergeToMainRequest, ) -> Result<VersionedChecklist, Error>

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.

pub fn update_data_source_ref_names( &self, auth_: &BearerToken, checklist_rid: &ChecklistRid, branch: Option<&BranchName>, ref_name_updates: &BTreeMap<DataSourceRefName, DataSourceRefName>, ) -> Result<VersionedChecklist, Error>

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

pub fn update_metadata( &self, auth_: &BearerToken, rid: &ChecklistRid, request: &UpdateChecklistMetadataRequest, ) -> Result<ChecklistMetadata, Error>

Updates the metadata of a checklist.

pub fn get( &self, auth_: &BearerToken, rid: &ChecklistRid, branch: Option<&BranchName>, commit: Option<&CommitId>, ) -> Result<VersionedChecklist, Error>

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

pub fn batch_get( &self, auth_: &BearerToken, checklist_refs: &BTreeSet<PinnedChecklistRef>, ) -> Result<BTreeSet<VersionedChecklist>, Error>

Returns the pinned commit for each provided checklist reference.

pub fn batch_get_metadata( &self, auth_: &BearerToken, request: &BatchGetChecklistMetadataRequest, ) -> Result<BatchGetChecklistMetadataResponse, Error>

Returns the metadata for each provided checklist.

pub fn search( &self, auth_: &BearerToken, request: &SearchChecklistsRequest, ) -> Result<VersionedChecklistPage, Error>

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

pub fn archive( &self, auth_: &BearerToken, request: &ArchiveChecklistsRequest, ) -> Result<(), Error>

Archives the provided checklists.

pub fn unarchive( &self, auth_: &BearerToken, request: &UnarchiveChecklistsRequest, ) -> Result<(), Error>

Unarchives the provided checklists.

pub fn get_check( &self, auth_: &BearerToken, rid: &CheckRid, ) -> Result<Check, Error>

Returns the check with the given rid.

pub fn batch_get_checks( &self, auth_: &BearerToken, rids: &BTreeSet<CheckRid>, ) -> Result<BTreeSet<Check>, Error>

Returns the checks with the given rids.

pub fn get_all_labels_and_properties( &self, auth_: &BearerToken, workspaces: &BTreeSet<WorkspaceRid>, ) -> Result<GetAllLabelsAndPropertiesResponse, Error>

Returns all labels and properties.

Trait Implementations

impl<T: Clone> Clone for ChecklistServiceClient<T>

fn clone(&self) -> ChecklistServiceClient<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for ChecklistServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Service<T> for ChecklistServiceClient<T>

where T: Client,

fn new(client: T) -> Self

Creates a new service wrapping an HTTP client.