Documentation Index
Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
Use this file to discover all available pages before exploring further.
prefect.server.events.clients
Classes
EventsClient
The abstract interface for a Prefect Events client
Methods:
emit
emit(self, event: Event) -> Optional[Event]
NullEventsClient
A no-op implementation of the Prefect Events client for testing
Methods:
client_name
emit
emit(self, event: Event) -> None
emit
emit(self, event: Event) -> None
AssertingEventsClient
An implementation of the Prefect Events client that records all events sent
to it for inspection during tests.
Methods:
assert_emitted_event_count
assert_emitted_event_count(cls, count: int) -> None
assert_emitted_event_with
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_no_emitted_event_with
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
emit
emit(self, event: Event) -> Event
emit
emit(self, event: Event) -> None
emitted_events_count
emitted_events_count(cls) -> int
reset
Reset all captured instances and their events. For use this between tests
PrefectServerEventsClient
Methods:
client_name
emit
emit(self, event: Event) -> ReceivedEvent
emit
emit(self, event: Event) -> None
PrefectServerEventsAPIClient
Methods:
pause_automation
pause_automation(self, automation_id: UUID) -> httpx.Response
resume_automation
resume_automation(self, automation_id: UUID) -> httpx.Response
