Checklist#

class nominal.core.Checklist(rid: str, name: str, description: str, properties: Mapping[str, str], labels: Sequence[str], commit_id: str | None = None)#

Bases: HasRid, RefreshableConjureMixin[VersionedChecklist]

A set of checks that can evaluate a run or monitor streaming asset data.

rid: str#
name: str#
description: str#
properties: Mapping[str, str]#
labels: Sequence[str]#
commit_id: str | None = None#

Loaded version ID; pass explicitly to execution to pin a review. None for unloaded manual instances.

property nominal_url: str#

Returns a link to the page for this checklist in the Nominal app

archive() → None#

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

execute(run: Run | str, commit: str | None = None) → DataReview#

Execute a checklist against a run.

Parameters:

  • run – Run (or its rid) to execute the checklist against

  • commit – Commit hash of the version of the checklist to run, or None for the latest version

Returns:

Created datareview for the checklist execution

execute_streaming(assets: Sequence[Asset | str], integration_rids: Sequence[str] | None = None, *, notifications: Sequence[Integration | str | StreamingNotificationConfig] | None = None, evaluation_delay: timedelta | int = timedelta(), recovery_delay: timedelta | int = timedelta(seconds=15), auto_create_events: bool = False) → None#

Start streaming or replace the streaming settings for the specified assets.

Settings for other assets are unchanged. Returning means the request was accepted; use get_streaming_status to inspect execution. It does not confirm notification delivery.

Parameters:

  • assets – Assets or their RIDs to run this published checklist against.

  • integration_rids – Notification integration RIDs with default settings. Existing positional and keyword calls remain supported but emit a deprecation warning. Pass these RIDs through notifications instead.

  • notifications – Integrations or their RIDs, optionally wrapped in StreamingNotificationConfig for tags, workbook links, and mute settings. Cannot be combined with integration_rids. Omitting both arguments or passing an empty list disables notifications.

  • evaluation_delay – Delay evaluation to accommodate late-arriving data, as a timedelta or integer nanoseconds.

  • recovery_delay – Minimum time before a failing check can recover, as a timedelta or integer nanoseconds. Must be at least 15 seconds.

  • auto_create_events – Create events when checks fail and update them when checks recover.

Raises:

ValueError – Both notification arguments are supplied, or a mute deadline lacks a timezone.

Note

This replaces all streaming settings for the specified assets, including existing notification destinations. Read get_streaming_configurations first to preserve settings when changing them.

get_streaming_configurations() → Mapping[str, StreamingChecklistConfiguration]#

Fetch streaming settings keyed by asset RID.

Notification destinations and workbooks are returned as RIDs without fetching those resources. A checklist with no streaming configuration raises the service’s not-found error.

get_streaming_status(assets: Sequence[Asset | str]) → Mapping[str, StreamingChecklistStatus]#

Fetch live status and check results keyed by asset RID.

Parameters:

assets – Assets or their RIDs already configured to stream this checklist. An asset without a streaming configuration causes the request to fail. An empty sequence returns an empty mapping.

Returns:

Status for each returned asset, including the executing commit when running.

Raises:

ValueError – The service returns a lifecycle or check-status variant unknown to the installed generated bindings. Upgrade the SDK to read newer status variants.

Note

Large reads use multiple requests and are not an atomic snapshot. If any request fails, the method raises without returning partial results.

preview_for_run_url(run: Run | str) → str#

Returns a link to the page for previewing this checklist on a given run in the Nominal app

refresh() → Self#
reload_streaming() → None#

Reload the checklist.

stop_streaming() → None#

Stop the checklist.

stop_streaming_for_assets(assets: Sequence[Asset | str]) → None#

Stop the checklist for the given assets.

unarchive() → None#

Unarchive this checklist, allowing it to be viewed in the UI.