prefect.events.worker

Functions

should_emit_events ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L40" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

should_emit_events() -> bool

emit_events_to_cloud ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L48" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit_events_to_cloud() -> bool

should_emit_events_to_running_server ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L55" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

should_emit_events_to_running_server() -> bool

should_emit_events_to_ephemeral_server ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L60" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

should_emit_events_to_ephemeral_server() -> bool

Classes

ProcessPoolForwardingEventsClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L29" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

An events client that forwards events to a parent process queue.

Methods:

client_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L170" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

client_name(self) -> str

emit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L173" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit(self, event: Event) -> None

Emit a single event

EventsWorker ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L64" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

attach_related_resources_from_context ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L106" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

attach_related_resources_from_context(self, event: Event) -> None

instance ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L131" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

instance(cls: Type[Self], client_type: Optional[Type[EventsClient]] = None) -> Self

set_client_override ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L121" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_client_override(cls, client_type: Optional[Type[EventsClient]], **client_kwargs: Any) -> None