# Core

`nominal.core` is the object-oriented client for the Nominal core platform.
Start with [`NominalClient`](https://dev.nominal.io/python/ref/generated/nominal.core.NominalClient.md#nominal.core.NominalClient "nominal.core.NominalClient"), then work with the resources it returns.
For setup and an end-to-end example, see the [Python quickstart](https://dev.nominal.io/python/guides/quickstart.md).

| [`ArchiveStatusFilter`](https://dev.nominal.io/python/ref/generated/nominal.core.ArchiveStatusFilter.md#nominal.core.ArchiveStatusFilter "nominal.core.ArchiveStatusFilter") | Filter for archive status in search methods. |
| --- | --- |
| [`as_files_ingested`](https://dev.nominal.io/python/ref/generated/nominal.core.as_files_ingested.md#nominal.core.as_files_ingested "nominal.core.as_files_ingested") | Iterates over DatasetFiles as they complete their ingestion in a similar fashion to [`concurrent.futures.as_completed`](https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.as_completed "(in Python v3.15)"). |
| [`Asset`](https://dev.nominal.io/python/ref/generated/nominal.core.Asset.md#nominal.core.Asset "nominal.core.Asset") | A logical grouping of datasets, runs, events, and attachments. |
| [`Attachment`](https://dev.nominal.io/python/ref/generated/nominal.core.Attachment.md#nominal.core.Attachment "nominal.core.Attachment") | An uploaded file that can be attached to assets or runs. |
| [`Bounds`](https://dev.nominal.io/python/ref/generated/nominal.core.Bounds.md#nominal.core.Bounds "nominal.core.Bounds") | Start and end timestamps of a time interval, in UTC nanoseconds. |
| [`BatchAddChannelsResult`](https://dev.nominal.io/python/ref/generated/nominal.core.BatchAddChannelsResult.md#nominal.core.BatchAddChannelsResult "nominal.core.BatchAddChannelsResult") | Results of a batch channel create or update, including unresolved requests. |
| [`Channel`](https://dev.nominal.io/python/ref/generated/nominal.core.Channel.md#nominal.core.Channel "nominal.core.Channel") | Metadata for working with channels. |
| [`ChannelDataType`](https://dev.nominal.io/python/ref/generated/nominal.core.ChannelDataType.md#nominal.core.ChannelDataType "nominal.core.ChannelDataType") | The type of values stored in a channel. |
| [`CreateChannelRequest`](https://dev.nominal.io/python/ref/generated/nominal.core.CreateChannelRequest.md#nominal.core.CreateChannelRequest "nominal.core.CreateChannelRequest") | Channel metadata to create or update through a dataset's batch methods. |
| [`filter_channels_with_data`](https://dev.nominal.io/python/ref/generated/nominal.core.filter_channels_with_data.md#nominal.core.filter_channels_with_data "nominal.core.filter_channels_with_data") | Yield channels that have data in the given time range, optionally filtered by tags. |
| [`Checklist`](https://dev.nominal.io/python/ref/generated/nominal.core.Checklist.md#nominal.core.Checklist "nominal.core.Checklist") | A set of checks that can evaluate a run or monitor streaming asset data. |
| [`CheckViolation`](https://dev.nominal.io/python/ref/generated/nominal.core.CheckViolation.md#nominal.core.CheckViolation "nominal.core.CheckViolation") | A checklist violation with its affected time interval and priority. |
| [`ContainerImage`](https://dev.nominal.io/python/ref/generated/nominal.core.ContainerImage.md#nominal.core.ContainerImage "nominal.core.ContainerImage") | A container image registered against a containerized extractor (nominal.registry.v2). |
| [`ContainerImageStatus`](https://dev.nominal.io/python/ref/generated/nominal.core.ContainerImageStatus.md#nominal.core.ContainerImageStatus "nominal.core.ContainerImageStatus") | Lifecycle status of a container image: PENDING while being processed, then READY or FAILED. |
| [`ContainerizedExtractor`](https://dev.nominal.io/python/ref/generated/nominal.core.ContainerizedExtractor.md#nominal.core.ContainerizedExtractor "nominal.core.ContainerizedExtractor") | A v2 (Nominal-hosted) containerized extractor (nominal.ingest.v2). |
| [`ContainerResources`](https://dev.nominal.io/python/ref/generated/nominal.core.ContainerResources.md#nominal.core.ContainerResources "nominal.core.ContainerResources") | Compute resources for an extractor container. |
| [`DataReview`](https://dev.nominal.io/python/ref/generated/nominal.core.DataReview.md#nominal.core.DataReview "nominal.core.DataReview") | The progress and results of a checklist execution. |
| [`DataReviewBuilder`](https://dev.nominal.io/python/ref/generated/nominal.core.DataReviewBuilder.md#nominal.core.DataReviewBuilder "nominal.core.DataReviewBuilder") | Collect checklist executions and notification destinations before initiating reviews. |
| [`Dataset`](https://dev.nominal.io/python/ref/generated/nominal.core.Dataset.md#nominal.core.Dataset "nominal.core.Dataset") | A collection of channels populated by uploaded files and streamed data. |
| [`DatasetFile`](https://dev.nominal.io/python/ref/generated/nominal.core.DatasetFile.md#nominal.core.DatasetFile "nominal.core.DatasetFile") | An uploaded dataset file and its ingestion status and time bounds. |
| [`DisplayOptions`](https://dev.nominal.io/python/ref/generated/nominal.core.DisplayOptions.md#nominal.core.DisplayOptions "nominal.core.DisplayOptions") | How Nominal resources display in notebooks. |
| [`DataStream`](https://dev.nominal.io/python/ref/core/streaming.md#nominal.core.DataStream "nominal.core.DataStream") |  |
| [`Event`](https://dev.nominal.io/python/ref/generated/nominal.core.Event.md#nominal.core.Event "nominal.core.Event") | An annotation at a point or interval in time, optionally associated with assets. |
| [`EventDisposition`](https://dev.nominal.io/python/ref/generated/nominal.core.EventDisposition.md#nominal.core.EventDisposition "nominal.core.EventDisposition") | The disposition opened on an event. |
| [`EventType`](https://dev.nominal.io/python/ref/generated/nominal.core.EventType.md#nominal.core.EventType "nominal.core.EventType") | Categorization for Nominal Core events. |
| [`ExitCodeMapping`](https://dev.nominal.io/python/ref/generated/nominal.core.ExitCodeMapping.md#nominal.core.ExitCodeMapping "nominal.core.ExitCodeMapping") | Map a failed container's exit code to a canonical extractor error. |
| [`FileExtractionInput`](https://dev.nominal.io/python/ref/generated/nominal.core.FileExtractionInput.md#nominal.core.FileExtractionInput "nominal.core.FileExtractionInput") | An input file the extractor consumes, exposed to the container via an environment variable. |
| [`FileExtractionParameter`](https://dev.nominal.io/python/ref/generated/nominal.core.FileExtractionParameter.md#nominal.core.FileExtractionParameter "nominal.core.FileExtractionParameter") | A scalar parameter passed to the extractor via an environment variable. |
| [`FileOutputFormat`](https://dev.nominal.io/python/ref/generated/nominal.core.FileOutputFormat.md#nominal.core.FileOutputFormat "nominal.core.FileOutputFormat") | File format a containerized extractor writes its output data in. |
| [`FileType`](https://dev.nominal.io/python/ref/generated/nominal.core.FileType.md#nominal.core.FileType "nominal.core.FileType") | Default upload extension and MIME type. |
| [`FileTypes`](https://dev.nominal.io/python/ref/generated/nominal.core.FileTypes.md#nominal.core.FileTypes "nominal.core.FileTypes") | Named file-type presets for SDK uploads. |
| [`get_display_options`](https://dev.nominal.io/python/ref/generated/nominal.core.get_display_options.md#nominal.core.get_display_options "nominal.core.get_display_options") | Return the current notebook display options. |
| [`HeaderProvider`](https://dev.nominal.io/python/ref/generated/nominal.core.HeaderProvider.md#nominal.core.HeaderProvider "nominal.core.HeaderProvider") | A provider of additional headers for SDK requests. |
| [`IngestionJob`](https://dev.nominal.io/python/ref/generated/nominal.core.IngestionJob.md#nominal.core.IngestionJob "nominal.core.IngestionJob") | A trackable record of one ingestion request moving through the async pipeline. |
| [`IngestionJobStatus`](https://dev.nominal.io/python/ref/generated/nominal.core.IngestionJobStatus.md#nominal.core.IngestionJobStatus "nominal.core.IngestionJobStatus") | Lifecycle status of an ingest job. |
| [`IngestType`](https://dev.nominal.io/python/ref/generated/nominal.core.IngestType.md#nominal.core.IngestType "nominal.core.IngestType") | The kind of data an ingest job ingests. |
| [`IngestWaitType`](https://dev.nominal.io/python/ref/generated/nominal.core.IngestWaitType.md#nominal.core.IngestWaitType "nominal.core.IngestWaitType") | The completion condition for [`wait_for_files_to_ingest`](https://dev.nominal.io/python/ref/generated/nominal.core.wait_for_files_to_ingest.md#nominal.core.wait_for_files_to_ingest "nominal.core.wait_for_files_to_ingest"). |
| [`Integration`](https://dev.nominal.io/python/ref/generated/nominal.core.Integration.md#nominal.core.Integration "nominal.core.Integration") | Reusable notification destination. |
| [`IntegrationDetails`](https://dev.nominal.io/python/ref/generated/nominal.core.IntegrationDetails.md#nominal.core.IntegrationDetails "nominal.core.IntegrationDetails") | Provider-specific settings returned with an [`Integration`](https://dev.nominal.io/python/ref/generated/nominal.core.Integration.md#nominal.core.Integration "nominal.core.Integration"). |
| [`LinkDict`](https://dev.nominal.io/python/ref/generated/nominal.core.LinkDict.md#nominal.core.LinkDict "nominal.core.LinkDict") | A resource link with a URL and an optional display title. |
| [`LogPoint`](https://dev.nominal.io/python/ref/generated/nominal.core.LogPoint.md#nominal.core.LogPoint "nominal.core.LogPoint") | LogPoint is a single, timestamped log entry. |
| [`LogStream`](https://dev.nominal.io/python/ref/core/streaming.md#nominal.core.LogStream "nominal.core.LogStream") |  |
| [`Marking`](https://dev.nominal.io/python/ref/generated/nominal.core.Marking.md#nominal.core.Marking "nominal.core.Marking") | A marking, restricting access to the data sources it is applied to. |
| [`Comment`](https://dev.nominal.io/python/ref/generated/nominal.core.Comment.md#nominal.core.Comment "nominal.core.Comment") | A comment posted to a resource's discussion. |
| [`NominalClient`](https://dev.nominal.io/python/ref/generated/nominal.core.NominalClient.md#nominal.core.NominalClient "nominal.core.NominalClient") | A client for uploading data and managing resources on the Nominal platform. |
| [`NominalProperties`](https://dev.nominal.io/python/ref/core/shared-types.md#nominal.core.NominalProperties "nominal.core.NominalProperties") |  |
| [`OpsgenieIntegrationDetails`](https://dev.nominal.io/python/ref/generated/nominal.core.OpsgenieIntegrationDetails.md#nominal.core.OpsgenieIntegrationDetails "nominal.core.OpsgenieIntegrationDetails") | Opsgenie configuration, without the API key. |
| [`OpsgenieRegion`](https://dev.nominal.io/python/ref/generated/nominal.core.OpsgenieRegion.md#nominal.core.OpsgenieRegion "nominal.core.OpsgenieRegion") | Region hosting an Opsgenie integration. |
| [`PagerDutyIntegrationDetails`](https://dev.nominal.io/python/ref/generated/nominal.core.PagerDutyIntegrationDetails.md#nominal.core.PagerDutyIntegrationDetails "nominal.core.PagerDutyIntegrationDetails") | Identifies a PagerDuty destination; its routing key is not returned. |
| [`Priority`](https://dev.nominal.io/python/ref/generated/nominal.core.Priority.md#nominal.core.Priority "nominal.core.Priority") | Check or event disposition priority, P0 most severe. |
| [`Run`](https://dev.nominal.io/python/ref/generated/nominal.core.Run.md#nominal.core.Run "nominal.core.Run") | A view of asset and dataset data within a time interval. |
| [`SearchEventOriginType`](https://dev.nominal.io/python/ref/generated/nominal.core.SearchEventOriginType.md#nominal.core.SearchEventOriginType "nominal.core.SearchEventOriginType") | An event source and creation category used to filter event searches. |
| [`Secret`](https://dev.nominal.io/python/ref/generated/nominal.core.Secret.md#nominal.core.Secret "nominal.core.Secret") | Metadata and lifecycle operations for a stored secret. |
| [`SecureWebhookIntegrationDetails`](https://dev.nominal.io/python/ref/generated/nominal.core.SecureWebhookIntegrationDetails.md#nominal.core.SecureWebhookIntegrationDetails "nominal.core.SecureWebhookIntegrationDetails") | Secure webhook settings, excluding the signing key. |
| [`set_display_options`](https://dev.nominal.io/python/ref/generated/nominal.core.set_display_options.md#nominal.core.set_display_options "nominal.core.set_display_options") | Change how Nominal resources display in notebooks. |
| [`SlackInstanceType`](https://dev.nominal.io/python/ref/generated/nominal.core.SlackInstanceType.md#nominal.core.SlackInstanceType "nominal.core.SlackInstanceType") | Slack environment used by a notification integration. |
| [`SlackWebhookIntegrationDetails`](https://dev.nominal.io/python/ref/generated/nominal.core.SlackWebhookIntegrationDetails.md#nominal.core.SlackWebhookIntegrationDetails "nominal.core.SlackWebhookIntegrationDetails") | Slack destination metadata, without webhook credentials. |
| [`StreamingChecklistConfiguration`](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingChecklistConfiguration.md#nominal.core.StreamingChecklistConfiguration "nominal.core.StreamingChecklistConfiguration") | Current streaming settings for one asset, returned by [`Checklist.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"). |
| [`StreamingChecklistState`](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingChecklistState.md#nominal.core.StreamingChecklistState "nominal.core.StreamingChecklistState") | Lifecycle state of a checklist running against one asset. |
| [`StreamingChecklistStatus`](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingChecklistStatus.md#nominal.core.StreamingChecklistStatus "nominal.core.StreamingChecklistStatus") | Live status for one asset, returned by [`Checklist.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"). |
| [`StreamingCheckState`](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingCheckState.md#nominal.core.StreamingCheckState "nominal.core.StreamingCheckState") | Latest evaluation state of an individual check. |
| [`StreamingCheckStatus`](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingCheckStatus.md#nominal.core.StreamingCheckStatus "nominal.core.StreamingCheckStatus") | Latest result for a check; parameter_index is zero-based, or None for a non-parameterized check. |
| [`StreamingNotificationConfig`](https://dev.nominal.io/python/ref/generated/nominal.core.StreamingNotificationConfig.md#nominal.core.StreamingNotificationConfig "nominal.core.StreamingNotificationConfig") | A notification destination and its settings for streaming checklist execution. |
| [`Symbol`](https://dev.nominal.io/python/ref/generated/nominal.core.Symbol.md#nominal.core.Symbol "nominal.core.Symbol") | A symbol used to identify a resource in the Nominal app. |
| [`SymbolKind`](https://dev.nominal.io/python/ref/generated/nominal.core.SymbolKind.md#nominal.core.SymbolKind "nominal.core.SymbolKind") | The kind of symbol carried by a [`Symbol`](https://dev.nominal.io/python/ref/generated/nominal.core.Symbol.md#nominal.core.Symbol "nominal.core.Symbol"). |
| [`TeamsIntegrationDetails`](https://dev.nominal.io/python/ref/generated/nominal.core.TeamsIntegrationDetails.md#nominal.core.TeamsIntegrationDetails "nominal.core.TeamsIntegrationDetails") | Identifies a Teams destination; its webhook credentials are not returned. |
| [`TimestampMetadata`](https://dev.nominal.io/python/ref/generated/nominal.core.TimestampMetadata.md#nominal.core.TimestampMetadata "nominal.core.TimestampMetadata") | How timestamps in the extractor's output data are encoded (the timestamp column + its type). |
| [`Unit`](https://dev.nominal.io/python/ref/generated/nominal.core.Unit.md#nominal.core.Unit "nominal.core.Unit") | Combination of the name and symbol of a unit within the supported systems of measurement. |
| [`UnitLike`](https://dev.nominal.io/python/ref/core/channels-and-units.md#nominal.core.UnitLike "nominal.core.UnitLike") | Represent a PEP 604 union type |
| [`UnknownIntegrationDetails`](https://dev.nominal.io/python/ref/generated/nominal.core.UnknownIntegrationDetails.md#nominal.core.UnknownIntegrationDetails "nominal.core.UnknownIntegrationDetails") | Integration details are unavailable or unrecognized by this SDK. |
| [`User`](https://dev.nominal.io/python/ref/generated/nominal.core.User.md#nominal.core.User "nominal.core.User") | A Nominal user's identity and contact details. |
| [`Video`](https://dev.nominal.io/python/ref/generated/nominal.core.Video.md#nominal.core.Video "nominal.core.Video") |  |
| [`VideoDatasetFile`](https://dev.nominal.io/python/ref/generated/nominal.core.VideoDatasetFile.md#nominal.core.VideoDatasetFile "nominal.core.VideoDatasetFile") | A video file stored as a dataset channel. |
| [`VideoFile`](https://dev.nominal.io/python/ref/generated/nominal.core.VideoFile.md#nominal.core.VideoFile "nominal.core.VideoFile") |  |
| [`wait_for_files_to_ingest`](https://dev.nominal.io/python/ref/generated/nominal.core.wait_for_files_to_ingest.md#nominal.core.wait_for_files_to_ingest "nominal.core.wait_for_files_to_ingest") | Blocks until all of the dataset files have completed their ingestion (or other specified conditions) in a similar fashion to [`concurrent.futures.wait`](https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.wait "(in Python v3.15)"). |
| [`WebhookContentType`](https://dev.nominal.io/python/ref/generated/nominal.core.WebhookContentType.md#nominal.core.WebhookContentType "nominal.core.WebhookContentType") | MIME type configured for a generic webhook. |
| [`WebhookDeliveryConfig`](https://dev.nominal.io/python/ref/generated/nominal.core.WebhookDeliveryConfig.md#nominal.core.WebhookDeliveryConfig "nominal.core.WebhookDeliveryConfig") | Secure webhook delivery settings. |
| [`WebhookIntegrationDetails`](https://dev.nominal.io/python/ref/generated/nominal.core.WebhookIntegrationDetails.md#nominal.core.WebhookIntegrationDetails "nominal.core.WebhookIntegrationDetails") | Generic webhook settings, excluding the destination URL and HMAC secret. |
| [`Workbook`](https://dev.nominal.io/python/ref/generated/nominal.core.Workbook.md#nominal.core.Workbook "nominal.core.Workbook") | An interactive view for visualizing data from assets and runs. |
| [`WorkbookTemplate`](https://dev.nominal.io/python/ref/generated/nominal.core.WorkbookTemplate.md#nominal.core.WorkbookTemplate "nominal.core.WorkbookTemplate") | A reusable workbook layout for creating workbooks with new data scopes. |
| [`WorkbookType`](https://dev.nominal.io/python/ref/generated/nominal.core.WorkbookType.md#nominal.core.WorkbookType "nominal.core.WorkbookType") | Workbook layouts for standard and comparison views. |
| [`Workspace`](https://dev.nominal.io/python/ref/generated/nominal.core.Workspace.md#nominal.core.Workspace "nominal.core.Workspace") | A workspace used to scope resource creation and searches. |
| [`WorkspaceSearchType`](https://dev.nominal.io/python/ref/generated/nominal.core.WorkspaceSearchType.md#nominal.core.WorkspaceSearchType "nominal.core.WorkspaceSearchType") | Workspace scope for searches: all accessible workspaces or the client's default workspace. |
| [`WriteStream`](https://dev.nominal.io/python/ref/generated/nominal.core.WriteStream.md#nominal.core.WriteStream "nominal.core.WriteStream") | A buffered asynchronous writer for time-series or log data. |

## Client and resources

| [Client](https://dev.nominal.io/python/ref/core/client.md) | Create a client, select a workspace, and configure requests. |
| --- | --- |
| [Assets and runs](https://dev.nominal.io/python/ref/core/assets-and-runs.md) | Organize datasets and runs, attach files, and add discussion comments. |
| [Workbooks](https://dev.nominal.io/python/ref/core/workbooks.md) | Manage workbooks and instantiate them from templates. |
| [Markings](https://dev.nominal.io/python/ref/core/markings.md) | Apply markings and configure their display symbols. |
| [Shared types](https://dev.nominal.io/python/ref/core/shared-types.md) | Look up time bounds, resource links, archive filters, and property types. |

## Data

| [Datasets and files](https://dev.nominal.io/python/ref/core/datasets-and-files.md) | Upload files, monitor ingestion, and work with dataset channels and exports. |
| --- | --- |
| [Channels and units](https://dev.nominal.io/python/ref/core/channels-and-units.md) | Inspect channel metadata, search tagged logs, and manage measurement units. |
| [Streaming](https://dev.nominal.io/python/ref/core/streaming.md) | Write timeseries data and log messages through asynchronous streams. |
| [Containerized extractors](https://dev.nominal.io/python/ref/core/containerized-extractors.md) | Register container images, configure extractors, and manage their secrets. |

## Events and validation

| [Events](https://dev.nominal.io/python/ref/core/events.md) | Create and classify events associated with Nominal resources. |
| --- | --- |
| [Automatic validation](https://dev.nominal.io/python/ref/core/automatic-validation.md) | Execute checklists, review violations, and configure notification integrations. |