Core#

nominal.core is the object-oriented client for the Nominal core platform. Start with NominalClient, then work with the resources it returns. For setup and an end-to-end example, see the Python quickstart.

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

Client and resources#

Client	Create a client, select a workspace, and configure requests.
Assets and runs	Organize datasets and runs, attach files, and add discussion comments.
Workbooks	Manage workbooks and instantiate them from templates.
Markings	Apply markings and configure their display symbols.
Shared types	Look up time bounds, resource links, archive filters, and property types.

Data#

Datasets and files	Upload files, monitor ingestion, and work with dataset channels and exports.
Channels and units	Inspect channel metadata, search tagged logs, and manage measurement units.
Streaming	Write timeseries data and log messages through asynchronous streams.
Containerized extractors	Register container images, configure extractors, and manage their secrets.

Events and validation#

Events	Create and classify events associated with Nominal resources.
Automatic validation	Execute checklists, review violations, and configure notification integrations.