Airflow Summit 2025 is coming October 07-09. Register now to secure your spot!

airflow.providers.edge3.worker_api.datamodels_ui

Classes

Worker

Details of the worker state sent to the scheduler.

WorkerCollectionResponse

Worker Collection serializer.

Job

Details of the job sent to the scheduler.

JobCollectionResponse

Job Collection serializer.

MaintenanceRequest

Request body for maintenance operations.

QueueUpdateRequest

Request body for queue operations.

Module Contents

class airflow.providers.edge3.worker_api.datamodels_ui.Worker(/, **data)[source]

Bases: airflow.providers.edge3.worker_api.datamodels.WorkerStateBody

Details of the worker state sent to the scheduler.

worker_name: Annotated[str, Field(description='Name of the worker.')][source]
first_online: Annotated[datetime.datetime | None, Field(description='When the worker was first online.')] = None[source]
last_heartbeat: Annotated[datetime.datetime | None, Field(description='When the worker last sent a heartbeat.')] = None[source]
class airflow.providers.edge3.worker_api.datamodels_ui.WorkerCollectionResponse(/, **data)[source]

Bases: airflow.api_fastapi.core_api.base.BaseModel

Worker Collection serializer.

workers: list[Worker][source]
total_entries: int[source]
class airflow.providers.edge3.worker_api.datamodels_ui.Job(/, **data)[source]

Bases: airflow.providers.edge3.worker_api.datamodels.EdgeJobBase

Details of the job sent to the scheduler.

state: Annotated[airflow.utils.state.TaskInstanceState, Field(description='State of the job from the view of the executor.')][source]
queue: Annotated[str, Field(description='Queue for which the task is scheduled/running.')][source]
queued_dttm: Annotated[datetime.datetime | None, Field(description='When the job was queued.')] = None[source]
edge_worker: Annotated[str | None, Field(description='The worker processing the job during execution.')] = None[source]
last_update: Annotated[datetime.datetime | None, Field(description='Last heartbeat of the job.')] = None[source]
class airflow.providers.edge3.worker_api.datamodels_ui.JobCollectionResponse(/, **data)[source]

Bases: airflow.api_fastapi.core_api.base.BaseModel

Job Collection serializer.

jobs: list[Job][source]
total_entries: int[source]
class airflow.providers.edge3.worker_api.datamodels_ui.MaintenanceRequest(/, **data)[source]

Bases: airflow.api_fastapi.core_api.base.BaseModel

Request body for maintenance operations.

maintenance_comment: Annotated[str, Field(description='Comment describing the maintenance reason.')][source]
class airflow.providers.edge3.worker_api.datamodels_ui.QueueUpdateRequest(/, **data)[source]

Bases: airflow.api_fastapi.core_api.base.BaseModel

Request body for queue operations.

queue_name: Annotated[str, Field(description='Name of the queue to add or remove.')][source]

Was this entry helpful?