prefect.server.utilities.worker_channel

Functions

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

work_pool_update_triggers_snapshot(update_values: Mapping[str, Any]) -> bool

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

close_worker_channel(websocket: WebSocket, close_reason: WorkerChannelCloseReason) -> None

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

build_worker_channel_work_pool_snapshot(session: AsyncSession, work_pool: ORMWorkPool) -> WorkPoolSnapshot

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

publish_snapshot_invalidation(invalidation: WorkerChannelSnapshotInvalidation) -> None

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

parse_snapshot_invalidation(message: messaging.Message) -> WorkerChannelSnapshotInvalidation

Classes

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

Methods:

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

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

targets(self) -> bool

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

Methods:

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

cleanup_enabled(self) -> bool

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

close(self, close_reason: WorkerChannelCloseReason) -> None

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

dispatch_one_cleanup_message(self) -> bool

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

has_cleanup_capacity(self) -> bool

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

queue_snapshot(self, invalidation: WorkerChannelSnapshotInvalidation) -> None

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

run(self, ready: WorkerReadyFrame, consumer_kwargs: Mapping[str, Any]) -> None