prefect.client.schemas.worker_channel

Shared v1 worker-channel protocol contract.

Functions

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

validate_worker_channel_frame(frame: Any) -> WorkerChannelApplicationFrame

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

select_worker_channel_version(supported_versions: Iterable[str]) -> WorkerChannelVersion

Classes

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

WorkerChannelClosePolicy ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/worker_channel.py#L109" 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.

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

WorkerChannelContract ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/worker_channel.py#L166" 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.

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

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

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

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

Methods:

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

default_cleanup_concurrency(cls, data: Any) -> Any

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

required_capabilities_are_requested(self) -> WorkerHelloPayload

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

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

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

Methods:

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

helpful_error_for_missing_default_queue_id(cls, v: Optional[UUID]) -> UUID

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

is_managed_pool(self) -> bool

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

is_push_pool(self) -> bool

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

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

Methods:

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

validate_capability_decision(self) -> WorkerReadyPayload

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

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

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

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

CancellingTimeoutTeardownTarget ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/worker_channel.py#L393" 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.

PendingClaimTeardownTarget ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/worker_channel.py#L400" 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.

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

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

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

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

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

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

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

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

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

Methods:

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

validate_result_contract(self) -> CleanupOperationResultPayload

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