bayesline.api.equity.AsyncRiskDatasetApi

class bayesline.api.equity.AsyncRiskDatasetApi

Bases: ABC

Methods

__init__()
describe()
update([force])	Checks the underlying datasets for updates and updates this dataset to the latest versions.
update_as_task([force])

Attributes

settings

abstract property settings: RiskDatasetSettings

abstract async describe() → RiskDatasetProperties

abstract async update(force: bool = False) → RiskDatasetUpdateResult

Checks the underlying datasets for updates and updates this dataset to the latest versions.

Parameters

force: bool

If true, the update will be forced even if the dataset is up to date.

Raises

DatasetError

if an error occurs

Returns

RiskDatasetUpdateResult

The result of the update operation.

abstract async update_as_task(force: bool = False) → AsyncTask[RiskDatasetUpdateResult]