Checklist#

class nominal.core.Checklist(rid, name, description, properties, labels, commit_id=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()#

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

execute(run, commit=None)#

Execute a checklist against a run.

Parameters:

  • run (Run | str)

    Run (or its rid) to execute the checklist against

  • commit (str | None)

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

Returns:

Created datareview for the checklist execution

Return type:

DataReview

execute_streaming(assets, integration_rids=None, *, notifications=None, evaluation_delay=timedelta(), recovery_delay=timedelta(seconds=15), auto_create_events=False)#

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 (Sequence[Asset | str])

    Assets or their RIDs to run this published checklist against.

  • integration_rids (Sequence[str] | None)

    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 (Sequence[Integration | str | StreamingNotificationConfig] | None)

    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 (timedelta | int)

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

  • recovery_delay (timedelta | int)

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

  • auto_create_events (bool)

    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()#

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.

Return type:

Mapping[str, StreamingChecklistConfiguration]

get_streaming_status(assets)#

Fetch live status and check results keyed by asset RID.

Parameters:

assets (Sequence[Asset | str])

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.

Return type:

Mapping[str, StreamingChecklistStatus]

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)#

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

Return type:

str

refresh()#
Return type:

Self

reload_streaming()#

Reload the checklist.

stop_streaming()#

Stop the checklist.

stop_streaming_for_assets(assets)#

Stop the checklist for the given assets.

unarchive()#

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