> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# worker

# `prefect.events.worker`

## Functions

### `should_emit_events` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L46](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L46)</sup>

```python theme={null}
should_emit_events() -> bool
```

### `emit_events_to_cloud` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L54](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L54)</sup>

```python theme={null}
emit_events_to_cloud() -> bool
```

### `should_emit_events_to_running_server` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L61](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L61)</sup>

```python theme={null}
should_emit_events_to_running_server() -> bool
```

### `should_emit_events_to_ephemeral_server` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L66](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L66)</sup>

```python theme={null}
should_emit_events_to_ephemeral_server() -> bool
```

## Classes

### `ProcessPoolForwardingEventsClient` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L35](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L35)</sup>

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

**Methods:**

#### `client_name` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L177](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L177)</sup>

```python theme={null}
client_name(self) -> str
```

#### `emit` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L180](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L180)</sup>

```python theme={null}
emit(self, event: Event) -> None
```

Emit a single event

### `EventsWorker` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L70)</sup>

**Methods:**

#### `attach_related_resources_from_context` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L110](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L110)</sup>

```python theme={null}
attach_related_resources_from_context(self, event: Event) -> None
```

#### `instance` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L154](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L154)</sup>

```python theme={null}
instance(cls: Type[Self], client_type: Optional[Type[EventsClient]] = None) -> Self
```

#### `set_client_override` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L144](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/worker.py#L144)</sup>

```python theme={null}
set_client_override(cls, client_type: Optional[Type[EventsClient]], **client_kwargs: Any) -> None
```
