airflow.providers.edge3.worker_api.datamodels¶

类¶

`WorkerApiDocs`	工作节点 API 的文档集合。
`JsonRpcRequestBase`	基础 JSON RPC 请求模型，仅定义方法。
`JsonRpcRequest`	JSON RPC 请求模型。
`EdgeJobBase`	边缘工作节点上作业的基本属性。
`EdgeJobFetched`	将在边缘工作节点上执行的作业。
`WorkerQueuesBase`	工作节点支持运行作业的队列。
`WorkerQueuesBody`	工作节点支持运行作业的队列。
`WorkerStateBody`	发送给调度器的工作节点状态详情。
`WorkerQueueUpdateBody`	工作节点已更改的队列。
`PushLogsBody`	工作节点的增量新日志内容。
`WorkerRegistrationReturn`	工作节点注册的返回类。
`WorkerSetStateReturn`	工作节点设置状态的返回类。

模块内容¶

class airflow.providers.edge3.worker_api.datamodels.WorkerApiDocs[source]¶

工作节点 API 的文档集合。

dag_id[source]¶

task_id[source]¶

run_id[source]¶

try_number[source]¶

map_index[source]¶

state[source]¶

class airflow.providers.edge3.worker_api.datamodels.JsonRpcRequestBase(/, **data)[source]¶

基类：pydantic.BaseModel

基础 JSON RPC 请求模型，仅定义方法。

method: Annotated[str, Field(description='通过 JSON RPC 调用的完全限定 Python 模块方法名称。')][source]¶

class airflow.providers.edge3.worker_api.datamodels.JsonRpcRequest(/, **data)[source]¶

基类：JsonRpcRequestBase

JSON RPC 请求模型。

jsonrpc: Annotated[str, Field(description='JSON RPC 版本', examples=['2.0'])][source]¶

params: Annotated[dict[str, Any] | None, Field(description='传递给方法的参数字典。')][source]¶

class airflow.providers.edge3.worker_api.datamodels.EdgeJobBase(/, **data)[source]¶

基类：pydantic.BaseModel

边缘工作节点上作业的基本属性。

dag_id: Annotated[str, Field(title='DAG ID', description='任务所属的 DAG 标识符。')][source]¶

task_id: Annotated[str, Field(title='任务 ID', description='DAG 中的任务名称。')][source]¶

run_id: Annotated[str, Field(title='运行 ID', description='DAG 执行的运行 ID。')][source]¶

map_index: Annotated[int, Field(title='映射索引', description='对于动态映射的任务，表示映射编号；如果任务未映射，则为 -1。')][source]¶

try_number: Annotated[int, Field(title='尝试次数', description='执行此任务的尝试次数。')][source]¶

property key: airflow.models.taskinstancekey.TaskInstanceKey[source]¶

class airflow.providers.edge3.worker_api.datamodels.EdgeJobFetched(/, **data)[source]¶

基类：EdgeJobBase

将在边缘工作节点上执行的作业。

command: Annotated[airflow.providers.edge3.worker_api.routes._v2_compat.ExecuteTask, Field(title='命令', description='用于在 Airflow 2 中执行作业的命令行。在 Airflow 3 中表示任务定义。')][source]¶

concurrency_slots: Annotated[int, Field(description='该作业所需的并发槽数量。')][source]¶

class airflow.providers.edge3.worker_api.datamodels.WorkerQueuesBase(/, **data)[source]¶

基类：pydantic.BaseModel

工作节点支持运行作业的队列。

queues: Annotated[list[str] | None, Field(None, description='工作节点从中拉取作业的队列列表。如果未提供，则工作节点会从所有队列拉取。')][source]¶

class airflow.providers.edge3.worker_api.datamodels.WorkerQueuesBody(/, **data)[source]¶

基类：WorkerQueuesBase

工作节点支持运行作业的队列。

free_concurrency: Annotated[int, Field(description='工作节点上的空闲并发槽数量。')][source]¶

class airflow.providers.edge3.worker_api.datamodels.WorkerStateBody(/, **data)[source]¶

基类：WorkerQueuesBase

发送给调度器的工作节点状态详情。

state: Annotated[airflow.providers.edge3.models.edge_worker.EdgeWorkerState, Field(description='从工作节点视角看的工作节点状态。')][source]¶

jobs_active: Annotated[int, Field(description='工作节点正在运行的活动作业数量。')] = 0[source]¶

queues: Annotated[list[str] | None, Field(description='工作节点从中拉取作业的队列列表。如果未提供，则工作节点会从所有队列拉取。')] = None[source]¶

sysinfo: Annotated[dict[str, str | int], Field(description='工作节点的系统信息。', examples=[{'concurrency': 4, 'free_concurrency': 3, 'airflow_version': '2.0.0', 'edge_provider_version': '1.0.0'}])][source]¶

maintenance_comments: Annotated[str | None, Field(description='关于工作节点维护状态的评论。')] = None[source]¶

class airflow.providers.edge3.worker_api.datamodels.WorkerQueueUpdateBody(/, **data)[source]¶

基类：pydantic.BaseModel

工作节点已更改的队列。

new_queues: Annotated[list[str] | None, Field(description='要添加到工作节点的附加队列。')][source]¶

remove_queues: Annotated[list[str] | None, Field(description='要从工作节点移除的队列。')][source]¶

class airflow.providers.edge3.worker_api.datamodels.PushLogsBody(/, **data)[source]¶

基类：pydantic.BaseModel

工作节点的增量新日志内容。

log_chunk_time: Annotated[datetime.datetime, Field(description='发送时日志块的时间戳。')][source]¶

log_chunk_data: Annotated[str, Field(description='日志块数据，作为增量日志文本。')][source]¶

class airflow.providers.edge3.worker_api.datamodels.WorkerRegistrationReturn(/, **data)[source]¶

基类：pydantic.BaseModel

工作节点注册的返回类。

last_update: Annotated[datetime.datetime, Field(description='工作器上次更新的时间。')][source]¶

class airflow.providers.edge3.worker_api.datamodels.WorkerSetStateReturn(/, **data)[source]¶

基类：pydantic.BaseModel

工作节点设置状态的返回类。

state: Annotated[airflow.providers.edge3.models.edge_worker.EdgeWorkerState, Field(description='从服务器视角看的工作器状态。')][source]¶

queues: Annotated[list[str] | None, Field(description='工作器从中拉取作业的队列列表。如果未提供，工作器将从所有队列拉取。')][source]¶

maintenance_comments: Annotated[str | None, Field(description='关于工作器维护状态的评论。')] = None[source]¶