API Reference - Mixins

Core mixins that provide reusable functionality across the Event Pipeline framework.

Identity Mixin

ObjectIdentityMixin

class ObjectIdentityMixin

Provides unique identification and state management functionality.

Methods:

id()

Property that returns a unique identifier for the object.

__object_import_str__()

Property that returns the import string for the object’s class.

get_state() → Dict[str, Any]

Get the serializable state of the object.

set_state(state: Dict[str, Any]) → None

Restore the object’s state from a dictionary.

Backend Integration

BackendIntegrationMixin

class BackendIntegrationMixin

Provides integration with backend storage systems.

Methods:

save()

Save the object to the backend store.

reload()

Reload the object’s state from the backend store.

delete()

Delete the object from the backend store.

update()

Update the object’s state in the backend store.

get_schema_name() → str

Get the schema name for backend storage.

Scheduling

ScheduleMixin

class ScheduleMixin

Provides scheduling capabilities for pipelines.

Inner Classes:

class ScheduleTrigger

Enumeration of available trigger types.

• DATE: One-time scheduled execution

• INTERVAL: Repeating execution at fixed intervals

• CRON: Cron-style scheduled execution

Methods:

schedule_job(trigger: ScheduleTrigger, **scheduler_kwargs)

Schedule a job for execution.

Parameters:

• trigger – The type of trigger to use

• scheduler_kwargs – Arguments for the specific trigger type

classmethod get_pipeline_scheduler()

Get the global pipeline scheduler instance.