Struct ChecklistServiceClient 

pub struct ChecklistServiceClient<C> { /* private fields */ }

Trait Implementations

impl<I: Iterator<Item = Result<Bytes, Error>>, __C> ChecklistService<I> for ChecklistServiceClient<__C>

where __C: Client<ResponseBody = I>,

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

Creates a new checklist with the provided checks.

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.

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.

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.

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.

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

Updates the metadata of a checklist.

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.

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

Returns the pinned commit for each provided checklist reference.

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

Returns the metadata for each provided checklist.

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

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

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

Archives the provided checklists.

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

Unarchives the provided checklists.

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

Returns the check with the given rid.

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

Returns the checks with the given rids.

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

Returns all labels and properties.

fn batch_edit_checklist_metadata( &self, auth_: &BearerToken, request: &BatchEditChecklistMetadataRequest, ) -> Result<BatchEditChecklistMetadataResponse, Error>

Batch edits metadata across multiple checklists. Supports rename/merge for labels and properties. If more than 1000 checklists are targeted, this endpoint will throw a 400.

impl<C: Clone> Clone for ChecklistServiceClient<C>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for ChecklistServiceClient<C>

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

Formats the value using the given formatter.

impl<C> Service<C> for ChecklistServiceClient<C>

fn new(client: C, runtime: &Arc<ConjureRuntime>) -> Self

Creates a new service wrapping an HTTP client.