Skip to main content

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.client.schemas.worker_channel

Shared v1 worker-channel protocol contract.

Functions

validate_worker_channel_frame

validate_worker_channel_frame(frame: Any) -> WorkerChannelApplicationFrame

select_worker_channel_version

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

Classes

WorkerChannelCloseReason

WorkerChannelClosePolicy

Methods:

model_validate_list

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

reset_fields

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

WorkerChannelContract

Methods:

model_validate_list

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

reset_fields

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

WorkerChannelAuthSuccess

WorkerChannelFrame

WorkerHelloPayload

Methods:

default_cleanup_concurrency

default_cleanup_concurrency(cls, data: Any) -> Any

required_capabilities_are_requested

required_capabilities_are_requested(self) -> WorkerHelloPayload

WorkerHelloFrame

ResolvedWorkQueue

WorkPoolSnapshot

Methods:

helpful_error_for_missing_default_queue_id

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

is_managed_pool

is_managed_pool(self) -> bool

is_push_pool

is_push_pool(self) -> bool

WorkPoolSnapshotPayload

WorkerReadyPayload

Methods:

validate_capability_decision

validate_capability_decision(self) -> WorkerReadyPayload

WorkerReadyFrame

WorkerHeartbeatPayload

WorkerHeartbeatFrame

WorkPoolSnapshotFrame

CancellingTimeoutTeardownTarget

Methods:

model_validate_list

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

reset_fields

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

Methods:

model_validate_list

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

reset_fields

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

PendingClaimCleanupMessagePayload

CleanupMessageFrame

CleanupOperationPayload

CleanupReleasePayload

CleanupAckFrame

CleanupReleaseFrame

CleanupRenewFrame

CleanupOperationResultPayload

Methods:

validate_result_contract

validate_result_contract(self) -> CleanupOperationResultPayload

CleanupOperationResultFrame