# 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*](https://dev.nominal.io/python/ref/generated/nominal.core.Run.md#nominal.core.Run "nominal.core.run.Run") *|* [*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"))

      Run (or its rid) to execute the checklist against
    - **commit** ([*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") *|* *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*](https://dev.nominal.io/python/ref/generated/nominal.core.DataReview.md#nominal.core.DataReview "nominal.core.data_review.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`](https://dev.nominal.io/python/ref/generated/nominal.core.Checklist.md#nominal.core.Checklist.get_streaming_status "nominal.core.Checklist.get_streaming_status") to inspect execution. It does not confirm notification delivery.

Parameters:
:   - **assets** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.15)")*[*[*Asset*](https://dev.nominal.io/python/ref/generated/nominal.core.Asset.md#nominal.core.Asset "nominal.core.asset.Asset") *|* [*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")*]*)

      Assets or their RIDs to run this published checklist against.
    - **integration_rids** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.15)")*[*[*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")*]* *|* *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*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.15)")*[*[*Integration*](https://dev.nominal.io/python/ref/generated/nominal.core.Integration.md#nominal.core.Integration "nominal.core.integration.Integration") *|* [*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)") *|* [*StreamingNotificationConfig*](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingNotificationConfig.md#nominal.core.StreamingNotificationConfig "nominal.core.streaming_checklist.StreamingNotificationConfig")*]* *|* *None*)

      Integrations or their RIDs, optionally wrapped in [`StreamingNotificationConfig`](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingNotificationConfig.md#nominal.core.StreamingNotificationConfig "nominal.core.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*](https://docs.python.org/3/library/datetime.html#datetime.timedelta "(in Python v3.15)") *|* [*int*](https://docs.python.org/3/builtins/functions.html#int "(in Python v3.15)"))

      Delay evaluation to accommodate late-arriving data, as a timedelta or integer nanoseconds.
    - **recovery_delay** ([*timedelta*](https://docs.python.org/3/library/datetime.html#datetime.timedelta "(in Python v3.15)") *|* [*int*](https://docs.python.org/3/builtins/functions.html#int "(in Python v3.15)"))

      Minimum time before a failing check can recover, as a timedelta or integer nanoseconds.
      Must be at least 15 seconds.
    - **auto_create_events** ([*bool*](https://docs.python.org/3/builtins/functions.html#bool "(in Python v3.15)"))

      Create events when checks fail and update them when checks recover.

Raises:
:   [**ValueError**](https://docs.python.org/3/builtins/exceptions.html#ValueError "(in Python v3.15)") – 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`](https://dev.nominal.io/python/ref/generated/nominal.core.Checklist.md#nominal.core.Checklist.get_streaming_configurations "nominal.core.Checklist.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*](https://docs.python.org/3/library/typing.html#typing.Mapping "(in Python v3.15)")[[*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [*StreamingChecklistConfiguration*](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingChecklistConfiguration.md#nominal.core.StreamingChecklistConfiguration "nominal.core.streaming_checklist.StreamingChecklistConfiguration")]

### get_streaming_status(assets)

Fetch live status and check results keyed by asset RID.

Parameters:
:   **assets** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.15)")*[*[*Asset*](https://dev.nominal.io/python/ref/generated/nominal.core.Asset.md#nominal.core.Asset "nominal.core.asset.Asset") *|* [*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")*]*)

    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**](https://docs.python.org/3/builtins/exceptions.html#ValueError "(in Python v3.15)") – 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*](https://docs.python.org/3/library/typing.html#typing.Mapping "(in Python v3.15)")[[*str*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)"), [*StreamingChecklistStatus*](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingChecklistStatus.md#nominal.core.StreamingChecklistStatus "nominal.core.streaming_checklist.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*](https://docs.python.org/3/builtins/stdtypes.html#str "(in Python v3.15)")

### refresh()

Return type:
:   [*Self*](https://docs.python.org/3/library/typing.html#typing.Self "(in Python v3.15)")

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