prefect.server.events.clients

Classes

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

The abstract interface for a Prefect Events client

Methods:

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

emit(self, event: Event) -> Optional[Event]

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

A no-op implementation of the Prefect Events client for testing

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/server/events/clients.py#L58" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit(self, event: Event) -> None

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

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

An implementation of the Prefect Events client that records all events sent to it for inspection during tests.

Methods:

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

assert_emitted_event_count(cls, count: int) -> None

Assert that the given number of events were emitted.

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

assert_emitted_event_with(cls, event: Optional[str] = None, resource: Optional[Dict[str, LabelValue]] = None, related: Optional[List[Dict[str, LabelValue]]] = None, payload: Optional[Dict[str, Any]] = None) -> None

Assert that an event was emitted containing the given properties.

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

assert_no_emitted_event_with(cls, event: Optional[str] = None, resource: Optional[Dict[str, LabelValue]] = None, related: Optional[List[Dict[str, LabelValue]]] = None, payload: Optional[Dict[str, Any]] = None) -> None

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/server/events/clients.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit(self, event: Event) -> Event

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

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

emitted_events_count(cls) -> int

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

reset(cls) -> None

Reset all captured instances and their events. For use this between tests

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

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/server/events/clients.py#L232" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit(self, event: Event) -> ReceivedEvent

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

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

Methods:

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

pause_automation(self, automation_id: UUID) -> httpx.Response

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

resume_automation(self, automation_id: UUID) -> httpx.Response