ChecklistsClient#

pub struct ChecklistsClient#

Client for checklist collection operations (get, search) and streaming attachment.

Implementations#

impl ChecklistsClient
pub async fn get(&self, rid: &str) -> Result<Checklist>#

Get a checklist by RID. Returns the latest commit on the main branch.

pub async fn search(&self, query: ChecklistQuery) -> Result<Vec<Checklist>>#

Search checklists with a query, collecting all pages eagerly.

The query is workspace-scoped when the client is configured with a workspace RID.

pub async fn list_for_asset(&self, asset_rid: &str) -> Result<Vec<Checklist>>#

List streaming checklists currently attached to the given asset.

Each attachment is hydrated via get, which returns the latest commit on the main branch.

pub async fn live_status(&self, checklist_rid: &str, asset_rid: &str) -> Result<ChecklistLiveStatus>#

Get the live status of a streaming checklist against a specific asset.

When the streaming checklist is running, the returned status carries the commit ID the evaluator currently has loaded, which may differ from the latest commit on the main branch. Errors with ChecklistExecution:StreamingChecklistNotFoundForAsset if no streaming checklist is attached to the asset.

pub async fn execute_streaming<I, S>(&self, checklist_rid: &str, asset_rids: I, options: ExecuteStreamingChecklist) -> Result<()> where I: IntoIterator<Item = S>, S: AsRef<str>#

Attach a streaming checklist to a set of assets.

If the checklist is already running on any of the given assets, the existing configuration is replaced with the one specified here.

pub async fn stop_streaming_for_assets<I, S>(&self, checklist_rid: &str, asset_rids: I) -> Result<()> where I: IntoIterator<Item = S>, S: AsRef<str>#

Stop a streaming checklist on the given assets.

pub async fn stop_streaming(&self, checklist_rid: &str) -> Result<()>#

Stop a streaming checklist on all assets it is currently attached to.

pub async fn archive(&self, checklist_rid: &str) -> Result<()>#

Archive a checklist. Archived checklists are hidden from the UI but not deleted.

pub async fn unarchive(&self, checklist_rid: &str) -> Result<()>#

Unarchive a checklist, restoring its visibility in the UI.

Trait implementations#

Auto traits: Send, Sync, Unpin, !UnwindSafe, !RefUnwindSafe