Overview
Settings reference
REST API
CLI Reference
Python SDK Reference
- artifacts
- automations
- cache_policies
- context
- engine
- exceptions
- filesystems
- flow_engine
- flow_runs
- flows
- futures
- main
- plugins
- results
- schedules
- serializers
- states
- task_engine
- task_runners
- task_runs
- task_worker
- tasks
- transactions
- variables
- prefect.assets
- prefect.blocks
- prefect.cli
- prefect.client
- prefect.concurrency
- prefect.deployments
- prefect.docker
- prefect.events
- prefect.infrastructure
- prefect.input
- prefect.locking
- prefect.logging
- prefect.runner
- prefect.runtime
- prefect.server
  - __init__
  - api
  - database
  - events
    - __init__
    - actions
    - clients
    - counting
    - filters
    - jinja_filters
    - messaging
    - models
    - ordering
    - pipeline
    - schemas
    - services
    - storage
    - stream
    - triggers
  - exceptions
  - logs
  - models
  - orchestration
  - schemas
  - services
  - task_queue
  - utilities
- prefect.settings
- prefect.telemetry
- prefect.testing
- prefect.types
- prefect.utilities
- prefect.workers

On this page

prefect.server.events.clients
Classes
EventsClient
emit
NullEventsClient
client_name
emit
emit
AssertingEventsClient
assert_emitted_event_count
assert_emitted_event_with
assert_no_emitted_event_with
client_name
emit
emit
emitted_events_count
reset
PrefectServerEventsClient
client_name
emit
emit
PrefectServerEventsAPIClient
pause_automation
resume_automation

`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`

client_name(self) -> str

`emit`

emit(self, event: Event) -> None

`emit`

emit(self, event: Event) -> None

Emit a single event

`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 that the given number of events were emitted.

`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 that an event was emitted containing the given properties.

`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`

client_name(self) -> str

`emit`

emit(self, event: Event) -> Event

`emit`

emit(self, event: Event) -> None

Emit a single event

`emitted_events_count`

emitted_events_count(cls) -> int

`reset`

reset(cls) -> None

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