bayesline.api.equity.RiskDatasetMetadata

model RiskDatasetMetadata

Metadata for a risk dataset.

namestr

The name of the risk dataset.

statusDatasetStatus

The status of the risk dataset. “ready” means the dataset is ready to use. “data_stale” means the dataset is ready to use but newer data is available. “needs_update” means local data needs to be computed/updated. “not_ready” means the reference dataset is not in a usable state. “corrupt” means the underlying settings are corrupted and need to be repaired.

sourceLiteral[“System”, “User”]

The source of the risk dataset.

reference_datasetstr | int | None

The reference dataset for the risk dataset (name or global int identifier). System datasets have no reference dataset.

cache_keystr | None, default=None

The cache key of the currently stored data. For system datasets, this is the cache key of the synced data. For user datasets, this is the cache key of the computed data. None if no local data exists.

latest_cache_keystr | None, default=None

The cache key that would result from an update. For system datasets, this is the cache key available on the remote source. For user datasets, this is the cache key computed from the current settings and reference dataset. None if the dataset is corrupt or reference is not ready.

data_datedt.date | None, default=None

The data date of the currently stored dataset. This represents the date of the market data used in the stored dataset. None if no local data exists.

last_updated_ondt.datetime | None, default=None

When the dataset was last updated/computed. None if not yet computed.

settings_created_ondt.datetime | None, default=None

When the dataset settings were first created. Only applies to user datasets; None for system datasets.

settings_last_updated_ondt.datetime | None, default=None

When the dataset settings were last modified. Only applies to user datasets; None for system datasets.

Fields

Field	Type	Required	Default
cache_key	str | None	No	None
data_date	date | None	No	None
last_updated_on	datetime | None	No	None
latest_cache_key	str | None	No	None
name	str	Yes
reference_dataset	str | int | None	Yes
settings_created_on	datetime | None	No	None
settings_last_updated_on	datetime | None	No	None
source	Literal[‘System’, ‘User’]	Yes
status	Literal[‘ready’, ‘data_stale’, ‘needs_update’, ‘not_ready’, ‘corrupt’]	Yes

field cache_key: str | None [Optional]

field data_date: date | None [Optional]

field last_updated_on: datetime | None [Optional]

field latest_cache_key: str | None [Optional]

field name: str [Required]

field reference_dataset: str | int | None [Required]

field settings_created_on: datetime | None [Optional]

field settings_last_updated_on: datetime | None [Optional]

field source: Literal['System', 'User'] [Required]

field status: Literal['ready', 'data_stale', 'needs_update', 'not_ready', 'corrupt'] [Required]