airflow の API リファレンス

airflow (apache/airflow) の公開 API 400 件 —— クラス 209、関数 142、メソッド 49。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	209
関数	142
メソッド	49

API 一覧

classairflow-core.hatch_build.CustomBuild

Custom build class for Airflow assets and git version.

methodairflow-core.hatch_build.CustomBuild.write_git_version() -> None

Write git version to git_version file.

classairflow-core.src.airflow.api.client.local_client.Client

Local API client implementation.

func

airflow-core.src.airflow.api.common.delete_dag.delete_dag(dag_id:str, keep_records_in_log:bool=True, *session:Session=NEW_SESSION) -> int

Delete a Dag by a dag_id.

funcairflow-core.src.airflow.api_fastapi.app.cached_app(config=None, testing=False, apps='all') -> FastAPI

Return cached instance of Airflow API app.

funcairflow-core.src.airflow.api_fastapi.app.init_auth_manager(app:FastAPI | None=None) -> BaseAuthManager

Initialize the auth manager.

funcairflow-core.src.airflow.api_fastapi.app.init_plugins(app:FastAPI) -> None

Integrate FastAPI app, middlewares and UI plugins.

classairflow-core.src.airflow.api_fastapi.auth.managers.models.base_user.BaseUser

User model interface.

classairflow-core.src.airflow.api_fastapi.auth.managers.models.resource_details.AssetAliasDetails

Represents the details of an asset alias.

classairflow-core.src.airflow.api_fastapi.auth.managers.models.resource_details.AssetDetails

Represents the details of an asset.

classairflow-core.src.airflow.api_fastapi.auth.managers.models.resource_details.BackfillDetails

Represents the details of a backfill.

classairflow-core.src.airflow.api_fastapi.auth.managers.models.resource_details.ConnectionDetails

Represents the details of a connection.

classairflow-core.src.airflow.api_fastapi.auth.managers.models.resource_details.DagDetails

Represents the details of a Dag.

classairflow-core.src.airflow.api_fastapi.auth.managers.models.resource_details.PoolDetails

Represents the details of a pool.

classairflow-core.src.airflow.api_fastapi.auth.managers.models.resource_details.TeamDetails

Represents the details of a team.

classairflow-core.src.airflow.api_fastapi.auth.managers.models.resource_details.VariableDetails

Represents the details of a variable.

classairflow-core.src.airflow.api_fastapi.auth.managers.simple.datamodels.login.LoginBody

classairflow-core.src.airflow.api_fastapi.auth.managers.simple.datamodels.login.LoginResponse

func

airflow-core.src.airflow.api_fastapi.auth.managers.simple.routes.login.create_token(body:LoginBody=Depends(parse_login_body)) -> LoginResponse

Authenticate the user.

funcairflow-core.src.airflow.api_fastapi.auth.managers.simple.routes.login.create_token_cli(body:LoginBody) -> LoginResponse

Authenticate the user for the CLI.

func

airflow-core.src.airflow.api_fastapi.auth.managers.simple.routes.login.login_all_admins(request:Request) -> RedirectResponse

classairflow-core.src.airflow.api_fastapi.auth.managers.simple.services.login.SimpleAuthManagerLogin

Service for login.

classairflow-core.src.airflow.api_fastapi.auth.managers.simple.simple_auth_manager.SimpleAuthManager

Simple auth manager.

method

airflow-core.src.airflow.api_fastapi.auth.managers.simple.simple_auth_manager.SimpleAuthManager.get_url_login(**kwargs) -> str

Return the login page url.

classairflow-core.src.airflow.api_fastapi.auth.middlewares.refresh_token.JWTRefreshMiddleware

Middleware to handle JWT token refresh.

classairflow-core.src.airflow.api_fastapi.auth.tokens.InvalidClaimError

Raised when a claim in the JWT is invalid.

classairflow-core.src.airflow.api_fastapi.auth.tokens.JWKS

A class to fetch and sync a set of JSON Web Keys.

methodairflow-core.src.airflow.api_fastapi.auth.tokens.JWKS.get_key(kid:str) -> jwt.PyJWK

Fetch the JWKS and find the matching key for the token.

classairflow-core.src.airflow.api_fastapi.auth.tokens.JWTGenerator

Generate JWT tokens.

method

airflow-core.src.airflow.api_fastapi.auth.tokens.JWTGenerator.generate(extras:dict[str, Any] | None=None, headers:dict[str, Any] | None=None, valid_for:float | None=None) -> str

Generate a signed JWT for the subject.

classairflow-core.src.airflow.api_fastapi.auth.tokens.JWTValidator

Validate the claims and validitory of a JWT.

func

airflow-core.src.airflow.api_fastapi.auth.tokens.get_signing_key(section:str, key:str, make_secret_key_if_needed:bool=True) -> str

Get a signing shared key from the config.

funcairflow-core.src.airflow.api_fastapi.auth.tokens.thumbprint(jwk:dict[str, Any], hashalg=hashes.SHA256()) -> str

Return the key thumbprint as specified by RFC 7638.

funcairflow-core.src.airflow.api_fastapi.common.cursors.decode_cursor(token:str) -> list[Any]

Decode a cursor token to the list of sort-key values.

funcairflow-core.src.airflow.api_fastapi.common.cursors.parse_cursor(cursor:str) -> tuple[str, bool]

Parse a raw cursor string into ``(token, is_backward)``.

classairflow-core.src.airflow.api_fastapi.common.exceptions.BaseErrorHandler

Base class for error handlers.

methodairflow-core.src.airflow.api_fastapi.common.exceptions.BaseErrorHandler.exception_handler(request:Request, exc:T)

exception_handler method.

classairflow-core.src.airflow.api_fastapi.common.exceptions.DagErrorHandler

Handler for Dag related errors.

classairflow-core.src.airflow.api_fastapi.common.parameters.FilterOptionEnum

Filter options for FilterParam.

classairflow-core.src.airflow.api_fastapi.common.parameters.FilterParam

Filter on attribute.

classairflow-core.src.airflow.api_fastapi.common.parameters.LimitFilter

Filter on the limit.

classairflow-core.src.airflow.api_fastapi.common.parameters.OffsetFilter

Filter on offset.

classairflow-core.src.airflow.api_fastapi.common.parameters.Range

Range with a lower and upper bound.

classairflow-core.src.airflow.api_fastapi.common.parameters.SortParam

Order result by the attribute.

methodairflow-core.src.airflow.api_fastapi.common.parameters.SortParam.row_value(row:Any, name:str) -> Any

Extract the sort-key value for ``name`` from a result row.

classairflow-core.src.airflow.api_fastapi.common.router.AirflowRouter

Extends the FastAPI default router.

classairflow-core.src.airflow.api_fastapi.common.types.MenuItem

Define all menu items defined in the menu.

classairflow-core.src.airflow.api_fastapi.common.types.Mimetype

Mimetype for the `Content-Type` header.

classairflow-core.src.airflow.api_fastapi.common.types.Theme

JSON to modify Chakra's theme.

classairflow-core.src.airflow.api_fastapi.common.types.ThemeColors

Color tokens for the UI theme.

classairflow-core.src.airflow.api_fastapi.common.types.UIAlert

Optional alert to be shown at the top of the page.

funcairflow-core.src.airflow.api_fastapi.core_api.app.init_flask_plugins(app:FastAPI) -> None

Integrate Flask plugins (plugins from Airflow 2).

funcairflow-core.src.airflow.api_fastapi.core_api.app.init_views(app:FastAPI) -> None

Init views by registering the different routers.

classairflow-core.src.airflow.api_fastapi.core_api.base.BaseModel

Base pydantic model for REST API.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.AssetAliasCollectionResponse

Asset alias collection response.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.AssetAliasResponse

Asset alias serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.AssetCollectionResponse

Asset collection response.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.AssetEventCollectionResponse

Asset event collection response.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.AssetEventResponse

Asset event serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.AssetResponse

Asset serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.AssetWatcherResponse

Asset watcher serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.CreateAssetEventsBody

Create asset events request.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.DagRunAssetReference

DagRun serializer for asset responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.LastAssetEventResponse

Last asset event response serializer.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.MaterializeAssetBody

Materialize asset request.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.QueuedEventResponse

Queued Event serializer for responses..

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.assets.TaskInletAssetReference

Task inlet reference serializer for assets.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.backfills.BackfillPostBody

Object used for create backfill request.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.backfills.BackfillResponse

Base serializer for Backfill.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.common.AssetExpressionAliasInfo

Body of an ``alias`` leaf node.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.common.AssetExpressionAssetInfo

Body of an ``asset`` leaf node.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.common.BulkAction

Bulk Action to be performed on the used model.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.common.BulkBaseAction

Base class for bulk actions.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.common.BulkBody

Serializer for bulk entity operations.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.config.Config

List of config sections with their options.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.config.ConfigOption

Config option.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.config.ConfigSection

Config Section Schema.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.connections.ConnectionBody

Connection Serializer for requests body.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.connections.ConnectionResponse

Connection serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_run.BulkDAGRunBody

Request body for bulk operations on Dag Runs.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_run.ClearPartitionsResponse

Response for the clearPartitions endpoint.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_run.DAGRunClearBody

Dag Run serializer for clear endpoint body.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_run.DAGRunPatchBody

Dag Run Serializer for PATCH requests.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_run.DAGRunResponse

Dag Run serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_run.DAGRunsBatchBody

List Dag Runs body for batch endpoint.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_run.TriggerDAGRunPostBody

Trigger Dag Run Serializer for POST body.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_sources.DAGSourceResponse

Dag Source serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_stats.DagStatsResponse

Dag Stats serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_stats.DagStatsStateResponse

DagStatsState serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_tags.DagTagResponse

Dag Tag serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_versions.DagVersionResponse

Dag Version serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dag_warning.DAGWarningResponse

Dag Warning serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dags.DAGCollectionResponse

Dag Collection serializer for responses.

methodairflow-core.src.airflow.api_fastapi.core_api.datamodels.dags.DAGDetailsResponse.concurrency() -> int

Return max_active_tasks as concurrency.

method

airflow-core.src.airflow.api_fastapi.core_api.datamodels.dags.DAGDetailsResponse.get_doc_md(doc_md:str | None) -> str | None

Clean indentation in doc md.

method

airflow-core.src.airflow.api_fastapi.core_api.datamodels.dags.DAGDetailsResponse.latest_dag_version() -> DagVersionResponse | None

Return the latest DagVersion.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dags.DAGPatchBody

Dag Serializer for updatable bodies.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.dags.DAGResponse

Dag serializer for responses.

methodairflow-core.src.airflow.api_fastapi.core_api.datamodels.dags.DAGResponse.file_token() -> str

Return file token.

methodairflow-core.src.airflow.api_fastapi.core_api.datamodels.dags.DAGResponse.get_owners(v:Any) -> list[str] | None

Convert owners attribute to Dag representation.

method

airflow-core.src.airflow.api_fastapi.core_api.datamodels.dags.DAGResponse.serialize_tags(tags:list[DagTagResponse]) -> list[DagTagResponse]

Sort tags alphabetically by name.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.event_logs.EventLogCollectionResponse

Event Log Collection Response.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.event_logs.EventLogResponse

Event Log Response.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.extra_links.ExtraLinkCollectionResponse

Extra Links Response.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.hitl.HITLDetail

Schema for Human-in-the-loop detail.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.hitl.HITLDetailHistory

Schema for Human-in-the-loop detail history.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.hitl.HITLDetailResponse

Response of updating a Human-in-the-loop detail.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.hitl.HITLUser

Schema for a Human-in-the-loop users.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.import_error.ImportErrorCollectionResponse

Import Error Collection Response.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.import_error.ImportErrorResponse

Import Error Response.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.job.JobCollectionResponse

Job Collection Response.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.job.JobResponse

Job serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.log.ExternalLogUrlResponse

Response for the external log URL endpoint.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.log.StructuredLogMessage

An individual log message.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.log.TaskInstancesLogResponse

Log serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.monitor.BaseInfoResponse

Base info serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.monitor.HealthInfoResponse

Health serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.monitor.SchedulerInfoResponse

Scheduler info serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.monitor.TriggererInfoResponse

Triggerer info serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.plugins.AppBuilderViewResponse

Serializer for AppBuilder View responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.plugins.BaseUIResponse

Base serializer for UI Plugin responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.plugins.FastAPIAppResponse

Serializer for Plugin FastAPI App responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.plugins.PluginCollectionResponse

Plugin Collection serializer.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.plugins.PluginResponse

Plugin serializer.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.plugins.ReactAppResponse

Serializer for React App Plugin responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.pools.BasePool

Base serializer for Pool.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.pools.PoolBody

Pool serializer for post bodies.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.pools.PoolCollectionResponse

Pool Collection serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.pools.PoolPatchBody

Pool serializer for patch bodies.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.pools.PoolResponse

Pool serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.providers.ProviderResponse

Provider serializer for responses.

method

airflow-core.src.airflow.api_fastapi.core_api.datamodels.task_instances.ClearTaskInstancesBody.validate_model(data:Any) -> Any

Validate clear task instance form.

method

airflow-core.src.airflow.api_fastapi.core_api.datamodels.task_instances.PatchTaskInstanceBody.validate_new_state(ns:str | None) -> str

Validate new_state.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.task_instances.TaskInstanceResponse

TaskInstance serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.task_instances.TaskInstancesBatchBody

Task Instance body for get batch.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.trigger.TriggerResponse

Trigger serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.auth.GenerateTokenBody

Request body for generating a token.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.auth.GenerateTokenResponse

Response for a generated token.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.auth.TokenType

Type of token to generate.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.common.BaseEdgeResponse

Base Edge serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.common.BaseGraphResponse

Base Graph serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.common.BaseNodeResponse

Base Node serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.common.GridNodeResponse

Base Node serializer for responses.

method

airflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.common.GridNodeResponse.get_doc_md(doc_md:str | None) -> str | None

Clean indentation in doc md.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.common.GridRunsResponse

Base Node serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.config.ConfigResponse

configuration serializer.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.dag_runs.DAGRunLightResponse

DAG Run serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.dags.DagTimetableTypeCollectionResponse

Timetable types used by Dags.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.dashboard.DAGRunStates

DAG Run States for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.dashboard.TaskInstanceStateCount

TaskInstance serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.deadline.DeadlineAlertResponse

DeadlineAlert serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.deadline.DeadlineResponse

Deadline serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.gantt.GanttResponse

Response for Gantt chart endpoint.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.gantt.GanttTaskInstance

Task instance data for Gantt chart.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.grid.GridTISummaries

DAG Run model for the Grid UI.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.partitioned_dag_runs.PartitionedDagRunResponse

Single partitioned Dag run item.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.structure.EdgeResponse

Edge serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.structure.NodeResponse

Node serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.structure.StructureDataResponse

Structure Data serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.teams.TeamCollectionResponse

Team collection serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.ui.teams.TeamResponse

Base serializer for Team.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.variables.VariableBody

Variable serializer for bodies.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.variables.VariableResponse

Variable serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.variables.VariablesImportResponse

Import Variables serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.version.VersionInfo

Version information serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.xcom.XComCollectionResponse

XCom Collection serializer for responses.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.xcom.XComCreateBody

Payload serializer for creating an XCom entry.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.xcom.XComResponse

Serializer for a xcom item.

classairflow-core.src.airflow.api_fastapi.core_api.datamodels.xcom.XComUpdateBody

Payload serializer for updating an XCom entry.

func

airflow-core.src.airflow.api_fastapi.core_api.openapi.exceptions.create_openapi_http_exception_doc(responses_status_code:Sequence[int | tuple[int, str]]) -> dict

Will create additional response example for errors raised by the endpoint.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.asset_state_store.clear_asset_state_store(asset_id:AssetIdDep, session:SessionDep) -> None

Delete all state store keys for an asset.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.asset_state_store.delete_asset_state_store(asset_id:AssetIdDep, key:str, session:SessionDep) -> None

Delete a single asset state store key.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.asset_state_store.set_asset_state_store(asset_id:AssetIdDep, key:str, body:AssetStateStoreBody, session:SessionDep) -> None

Set an asset state store value.

classairflow-core.src.airflow.api_fastapi.core_api.routes.public.assets.OnlyActiveFilter

Filter on asset activeness.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.assets.create_asset_event(body:CreateAssetEventsBody, session:SessionDep, user:GetUserDep) -> AssetEventResponse

Create asset events.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.assets.get_asset(asset_id:int, session:SessionDep) -> AssetResponse

Get an asset.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.assets.get_asset_alias(asset_alias_id:int, session:SessionDep)

Get an asset alias.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.auth.logout(request:Request, auth_manager:AuthManagerDep) -> RedirectResponse

Logout the user.

funcairflow-core.src.airflow.api_fastapi.core_api.routes.public.connections.create_default_connections(session:SessionDep)

Create default connections.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.connections.delete_connection(connection_id:str, session:SessionDep)

Delete a connection entry.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.connections.get_connection(connection_id:str, session:SessionDep) -> ConnectionResponse

Get a connection entry.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.connections.patch_connection(connection_id:str, patch_body:ConnectionBody, session:SessionDep, update_mask:list[str] | None=Query(None)) -> ConnectionResponse

Update a connection entry.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.connections.post_connection(post_body:ConnectionBody, session:SessionDep) -> ConnectionResponse

Create connection entry.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dag_parsing.reparse_dag_file(file_token:str, session:SessionDep, request:Request) -> None

Request re-parsing a Dag file.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dag_run.bulk_dag_runs(request:BulkBody[BulkDAGRunBody], session:SessionDep, dag_id:str, dag_bag:DagBagDep, user:GetUserDep) -> BulkResponse

Bulk update or delete Dag Runs.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dag_run.delete_dag_run(dag_id:str, dag_run_id:str, session:SessionDep)

Delete a Dag Run entry.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dag_run.patch_dag_run(dag_id:str, dag_run_id:str, patch_body:DAGRunPatchBody, session:SessionDep, dag_bag:DagBagDep, user:GetUserDep, update_mask:list[str] | None=Query(None)) -> DAGRunResponse

Modify a Dag Run.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dag_run.trigger_dag_run(dag_id, body:TriggerDAGRunPostBody, dag_bag:DagBagDep, user:GetUserDep, session:SessionDep, request:Request) -> DAGRunResponse

Trigger a Dag.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dag_versions.get_dag_version(dag_id:str, version_number:int, session:SessionDep) -> DagVersionResponse

Get one Dag Version.

funcairflow-core.src.airflow.api_fastapi.core_api.routes.public.dags.delete_dag(dag_id:str, session:SessionDep) -> Response

Delete the specific Dag.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dags.favorite_dag(dag_id:str, session:SessionDep, user:GetUserDep)

Mark the Dag as favorite.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dags.get_dag(dag_id:str, session:SessionDep, dag_bag:DagBagDep) -> DAGResponse

Get basic information about a Dag.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dags.get_dag_details(dag_id:str, session:SessionDep, dag_bag:DagBagDep, user:GetUserDep) -> DAGDetailsResponse

Get details of Dag.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dags.patch_dag(dag_id:str, patch_body:DAGPatchBody, session:SessionDep, update_mask:list[str] | None=Query(None)) -> DAGResponse

Patch the specific Dag.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.dags.unfavorite_dag(dag_id:str, session:SessionDep, user:GetUserDep)

Unmark the Dag as favorite.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.import_error.get_import_error(import_error_id:int, session:SessionDep, user:GetUserDep) -> ImportErrorResponse

Get an import error.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.pools.bulk_pools(request:BulkBody[PoolBody], session:SessionDep) -> BulkResponse

Bulk create, update, and delete pools.

funcairflow-core.src.airflow.api_fastapi.core_api.routes.public.pools.delete_pool(pool_name:str, session:SessionDep)

Delete a pool entry.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.pools.get_pool(pool_name:str, session:SessionDep) -> PoolResponse

Get a pool.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.pools.patch_pool(pool_name:str, patch_body:PoolPatchBody, session:SessionDep, update_mask:list[str] | None=Query(None)) -> PoolResponse

Update a Pool.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.pools.post_pool(body:PoolBody, session:SessionDep) -> PoolResponse

Create a Pool.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.providers.get_providers(limit:QueryLimit, offset:QueryOffset) -> ProviderCollectionResponse

Get providers.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.task_instances.delete_task_instance(dag_id:str, dag_run_id:str, task_id:str, session:SessionDep, map_index:int=-1) -> None

Delete a task instance.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.task_instances.get_mapped_task_instance(dag_id:str, dag_run_id:str, task_id:str, map_index:int, session:SessionDep) -> TaskInstanceResponse

Get task instance.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.task_instances.get_task_instance(dag_id:str, dag_run_id:str, task_id:str, session:SessionDep) -> TaskInstanceResponse

Get task instance.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.task_instances.post_clear_task_instances(dag_id:str, dag_bag:DagBagDep, body:ClearTaskInstancesBody, session:SessionDep, user:GetUserDep) -> TaskInstanceCollectionResponse

Clear task instances.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.variables.bulk_variables(request:BulkBody[VariableBody], session:SessionDep) -> BulkResponse

Bulk create, update, and delete variables.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.variables.delete_variable(variable_key:str, session:SessionDep)

Delete a variable entry.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.variables.get_variable(variable_key:str, session:SessionDep) -> VariableResponse

Get a variable entry.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.variables.patch_variable(variable_key:str, patch_body:VariableBody, session:SessionDep, update_mask:list[str] | None=Query(None)) -> VariableResponse

Update a variable by key.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.variables.post_variable(post_body:VariableBody, session:SessionDep) -> VariableResponse

Create a variable.

funcairflow-core.src.airflow.api_fastapi.core_api.routes.public.version.get_version() -> VersionInfo

Get version information.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.xcom.create_xcom_entry(dag_id:str, task_id:str, dag_run_id:str, request_body:XComCreateBody, session:SessionDep, dag_bag:DagBagDep) -> XComResponseNative

Create an XCom entry.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.public.xcom.update_xcom_entry(dag_id:str, task_id:str, dag_run_id:str, xcom_key:str, patch_body:XComUpdateBody, *session:SessionDep) -> XComResponseNative

Update an existing XCom entry.

funcairflow-core.src.airflow.api_fastapi.core_api.routes.ui.config.get_configs() -> ConfigResponse

Get configs for UI.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.ui.dags.get_latest_run_info(dag_id:str, session:SessionDep) -> DAGRunLightResponse | None

Get latest run.

func

airflow-core.src.airflow.api_fastapi.core_api.routes.ui.gantt.get_gantt_data(dag_id:str, run_id:str, session:SessionDep) -> GanttResponse

Get all task instance tries for Gantt chart.

funcairflow-core.src.airflow.api_fastapi.core_api.security.is_safe_url(target_url:str, request:Request | None=None) -> bool

Check that the URL is safe.

classairflow-core.src.airflow.api_fastapi.core_api.services.public.common.BulkService

Base class for bulk service operations.

method

airflow-core.src.airflow.api_fastapi.core_api.services.public.common.BulkService.handle_bulk_create(action:BulkCreateAction[T], results:BulkActionResponse) -> None

Bulk create entities.

method

airflow-core.src.airflow.api_fastapi.core_api.services.public.common.BulkService.handle_bulk_delete(action:BulkDeleteAction[T], results:BulkActionResponse) -> None

Bulk delete entities.

method

airflow-core.src.airflow.api_fastapi.core_api.services.public.common.BulkService.handle_bulk_update(action:BulkUpdateAction[T], results:BulkActionResponse) -> None

Bulk update entities.

methodairflow-core.src.airflow.api_fastapi.core_api.services.public.common.BulkService.handle_request() -> BulkResponse

Handle request for bulk actions.

func

airflow-core.src.airflow.api_fastapi.core_api.services.public.dag_run.patch_dag_run_note(*dag_run:DagRun, *note:str | None, *user:BaseUser) -> None

Set, update, or clear a Dag Run's note.

method

airflow-core.src.airflow.api_fastapi.core_api.services.public.pools.BulkPoolService.handle_bulk_create(action:BulkCreateAction[PoolBody], results:BulkActionResponse) -> None

Bulk create pools.

method

airflow-core.src.airflow.api_fastapi.core_api.services.public.pools.BulkPoolService.handle_bulk_delete(action:BulkDeleteAction[PoolBody], results:BulkActionResponse) -> None

Bulk delete pools.

method

airflow-core.src.airflow.api_fastapi.core_api.services.public.pools.BulkPoolService.handle_bulk_update(action:BulkUpdateAction[PoolBody], results:BulkActionResponse) -> None

Bulk Update pools.

func

airflow-core.src.airflow.api_fastapi.core_api.services.public.pools.update_orm_from_pydantic(pool_name:str, patch_body:PoolBody | PoolPatchBody, update_mask:list[str] | None, session:SessionDep) -> Pool

Update an existing pool.

func

airflow-core.src.airflow.api_fastapi.core_api.services.public.variables.update_orm_from_pydantic(variable_key:str, patch_body:VariableBody, update_mask:list[str] | None, session:SessionDep) -> Variable

Update an existing Variable.

classairflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.MockAnyWidget

Mock any flask appbuilder widget.

classairflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.MockBaseField

Mock of WTForms Field.

classairflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.MockBooleanField

Mock of WTForms BooleanField.

classairflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.MockEnum

Mock for wtforms.validators.AnyOf.

classairflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.MockIntegerField

Mock of WTForms IntegerField.

classairflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.MockOptional

Mock for wtforms.validators.Optional.

classairflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.MockPasswordField

Mock of WTForms PasswordField.

classairflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.MockStringField

Mock of WTForms StringField.

func

airflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.mock_any_of(allowed_values:list) -> HookMetaService.MockEnum

Mock for wtforms.validators.any_of.

funcairflow-core.src.airflow.api_fastapi.core_api.services.ui.connections.HookMetaService.mock_lazy_gettext(txt:str) -> str

Mock for flask_babel.lazy_gettext.

func

airflow-core.src.airflow.api_fastapi.execution_api.app.create_task_execution_api_app(lifespan:svcs.fastapi.lifespan=lifespan) -> FastAPI

Create FastAPI app for task execution API.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.asset.AssetProfile

Profile of an asset-like object.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.asset_event.AssetEventsResponse

Collection of AssetEventResponse.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.asset_event.DagRunAssetReference

DagRun serializer for asset responses.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.dagrun.DagRunStateResponse

Schema for DAG Run State response.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.dagrun.TriggerDAGRunPayload

Schema for Trigger DAG Run API request.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.dags.DagResponse

Schema for DAG response.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.hitl.HITLUser

Schema for a Human-in-the-loop users.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.taskinstance.InactiveAssetsResponse

Response for inactive assets.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.taskinstance.TaskBreadcrumbsResponse

Response for task breadcrumbs.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.token.TIClaims

Validated JWT claims for a task identity token.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.token.TIToken

Task Identity Token.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.variable.VariableKeysResponse

Variable keys schema for list responses.

classairflow-core.src.airflow.api_fastapi.execution_api.datamodels.variable.VariablePostBody

Request body schema for creating variables.

func

airflow-core.src.airflow.api_fastapi.execution_api.routes.assets.get_asset_by_name(name:Annotated[str, Query(description='The name of the Asset')], session:SessionDep) -> AssetResponse

Get an Airflow Asset by `name`.

func

airflow-core.src.airflow.api_fastapi.execution_api.routes.assets.get_asset_by_uri(uri:Annotated[str, Query(description='The URI of the Asset')], session:SessionDep) -> AssetResponse

Get an Airflow Asset by `uri`.

func

airflow-core.src.airflow.api_fastapi.execution_api.routes.dag_runs.clear_dag_run(dag_id:str, run_id:str, session:SessionDep, dag_bag:DagBagDep) -> None

Clear a Dag run.

func

airflow-core.src.airflow.api_fastapi.execution_api.routes.dag_runs.get_dag_run(dag_id:str, run_id:str, session:SessionDep) -> DagRun

Get detail of a Dag run.

func

airflow-core.src.airflow.api_fastapi.execution_api.routes.dag_runs.get_dagrun_state(dag_id:str, run_id:str, session:SessionDep) -> DagRunStateResponse

Get a Dag run State.

func

airflow-core.src.airflow.api_fastapi.execution_api.routes.dag_runs.trigger_dag_run(dag_id:str, run_id:str, payload:TriggerDAGRunPayload, session:SessionDep, token:TIToken=CurrentTIToken) -> None

Trigger a Dag run.

funcairflow-core.src.airflow.api_fastapi.execution_api.routes.dags.get_dag(dag_id:str, session:SessionDep) -> DagResponse

Get a DAG.

func

airflow-core.src.airflow.api_fastapi.execution_api.routes.variables.get_variable(variable_key:Annotated[str, Path(min_length=1)], team_name:Annotated[str | None, Depends(get_team_name_dep)]) -> VariableResponse

Get an Airflow Variable.

classairflow-core.src.airflow.api_fastapi.execution_api.routes.xcoms.GetXComSliceFilterParams

Class to house slice params.

classairflow-core.src.airflow.api_fastapi.execution_api.security.JWTBearer

Validates JWT tokens for the Execution API.

classairflow-core.src.airflow.api_fastapi.execution_api.versions.v2026_04_06.AddDagEndpoint

Add the `/dags/{dag_id}` endpoint.

classairflow-core.src.airflow.api_fastapi.execution_api.versions.v2026_04_06.AddDagRunDetailEndpoint

Add dag run detail endpoint.

classairflow-core.src.airflow.api_fastapi.execution_api.versions.v2026_04_06.AddNoteField

Add note parameter to DagRun Model.

funcairflow-core.src.airflow.api_fastapi.logging.decorators.log_action(request:Request, session:SessionDep, user:GetUserDep)

Log user actions.

classairflow-core.src.airflow.assets.manager.AssetManager

A pluggable class that manages operations for assets.

method

airflow-core.src.airflow.assets.manager.AssetManager.create_asset_aliases(asset_aliases:list[SerializedAssetAlias], *session:Session) -> list[AssetAliasModel]

Create new asset aliases.

method

airflow-core.src.airflow.assets.manager.AssetManager.create_assets(assets:list[SerializedAsset], *session:Session) -> list[AssetModel]

Create new assets.

funcairflow-core.src.airflow.assets.manager.resolve_asset_manager() -> AssetManager

Retrieve the asset manager.

classairflow-core.src.airflow.callbacks.base_callback_sink.BaseCallbackSink

Base class for Callbacks Sinks.

methodairflow-core.src.airflow.callbacks.base_callback_sink.BaseCallbackSink.send(callback:CallbackRequest) -> None

Send callback for execution.

classairflow-core.src.airflow.callbacks.callback_requests.TaskCallbackRequest

Task callback status information.

classairflow-core.src.airflow.callbacks.database_callback_sink.DatabaseCallbackSink

Sends callbacks to database.

method

airflow-core.src.airflow.callbacks.database_callback_sink.DatabaseCallbackSink.send(callback:CallbackRequest, *session:Session=NEW_SESSION) -> None

Send callback for execution.

classairflow-core.src.airflow.cli.cli_config.ActionCommand

Single CLI command.

classairflow-core.src.airflow.cli.cli_config.Arg

Class to keep information about command line argument.

methodairflow-core.src.airflow.cli.cli_config.Arg.add_to_parser(parser:argparse.ArgumentParser)

Add this argument to an ArgumentParser.

classairflow-core.src.airflow.cli.cli_config.DefaultHelpParser

CustomParser to display help message.

methodairflow-core.src.airflow.cli.cli_config.DefaultHelpParser.error(message)

Override error and use print_help instead of print_usage.

classairflow-core.src.airflow.cli.cli_config.GroupCommand

ClI command with subcommands.

funcairflow-core.src.airflow.cli.cli_config.lazy_load_command(import_path:str) -> Callable

Create a lazy loader for command.

funcairflow-core.src.airflow.cli.cli_config.string_lower_type(val)

Lower arg.

classairflow-core.src.airflow.cli.cli_parser.AirflowHelpFormatter

Custom help formatter to display help message.

classairflow-core.src.airflow.cli.cli_parser.LazyRichHelpFormatter

Custom help formatter to display help message.

funcairflow-core.src.airflow.cli.cli_parser.get_long_option(arg:Arg)

Get long option from Arg.flags.

funcairflow-core.src.airflow.cli.cli_parser.get_parser(dag_parser:bool=False) -> argparse.ArgumentParser

Create and returns command line argument parser.

funcairflow-core.src.airflow.cli.commands.api_server_command.api_server(args:Namespace)

Start Airflow API server.

funcairflow-core.src.airflow.cli.commands.asset_command.asset_details(args, *session:Session=NEW_SESSION) -> None

Display details of an asset.

funcairflow-core.src.airflow.cli.commands.asset_command.asset_list(args, *session:Session=NEW_SESSION) -> None

Display assets in the command line.

funcairflow-core.src.airflow.cli.commands.asset_command.asset_materialize(args, *session:Session=NEW_SESSION) -> None

Materialize the specified asset.

funcairflow-core.src.airflow.cli.commands.cheat_sheet_command.cheat_sheet(args)

Display cheat-sheet.

classairflow-core.src.airflow.cli.commands.config_command.ConfigParameter

Represents a configuration parameter.

funcairflow-core.src.airflow.cli.commands.config_command.get_value(args)

Get one value from configuration.

funcairflow-core.src.airflow.cli.commands.connection_command.connections_add(args)

Add new connection.

funcairflow-core.src.airflow.cli.commands.connection_command.connections_get(args)

Get a connection.

funcairflow-core.src.airflow.cli.commands.connection_command.connections_test(args) -> None

Test an Airflow connection.

funcairflow-core.src.airflow.cli.commands.dag_command.dag_details(args, *session:Session=NEW_SESSION)

Get DAG details given a DAG id.

func

airflow-core.src.airflow.cli.commands.dag_command.dag_list_dag_runs(args, dag:DAG | None=None, *session:Session=NEW_SESSION) -> None

List dag runs for a given DAG.

funcairflow-core.src.airflow.cli.commands.dag_command.dag_list_dags(args, *session:Session=NEW_SESSION) -> None

Display dags with or without stats at the command line.

funcairflow-core.src.airflow.cli.commands.dag_command.dag_list_import_errors(args, *session:Session=NEW_SESSION) -> None

Display dags with import errors on the command line.

func

airflow-core.src.airflow.cli.commands.dag_command.dag_list_jobs(args, dag:DAG | None=None, *session:Session=NEW_SESSION) -> None

List latest n jobs.

funcairflow-core.src.airflow.cli.commands.dag_command.dag_pause(args) -> None

Pauses a DAG.

funcairflow-core.src.airflow.cli.commands.dag_command.dag_report(args) -> None

Display dagbag stats at the command line.

funcairflow-core.src.airflow.cli.commands.dag_command.dag_reserialize(args, *session:Session=NEW_SESSION) -> None

Serialize a DAG instance.

funcairflow-core.src.airflow.cli.commands.dag_command.dag_trigger(args) -> None

Create a dag run for the specified dag.

funcairflow-core.src.airflow.cli.commands.dag_command.dag_unpause(args) -> None

Unpauses a DAG.

func

airflow-core.src.airflow.cli.commands.dag_command.set_is_paused(is_paused:bool, args, *session:Session=NEW_SESSION) -> None

Set is_paused for DAG by a given dag_id.

funcairflow-core.src.airflow.cli.commands.db_command.migratedb(args)

Migrates the metadata database.

funcairflow-core.src.airflow.cli.commands.db_command.resetdb(args)

Reset the metadata database.

func

airflow-core.src.airflow.cli.commands.db_command.run_db_downgrade_command(args, command, revision_heads_map:dict[str, str])

Run the db downgrade command.

func

airflow-core.src.airflow.cli.commands.db_command.run_db_migrate_command(args, command, revision_heads_map:dict[str, str])

Run the db migrate command.

funcairflow-core.src.airflow.cli.commands.db_manager_command.resetdb(args)

Reset the metadata database.

classairflow-core.src.airflow.cli.commands.info_command.AirflowInfo

Renders information about Airflow instance.

methodairflow-core.src.airflow.cli.commands.info_command.AirflowInfo.render_text(output:str) -> str

Export the info to string.

method

airflow-core.src.airflow.cli.commands.info_command.AirflowInfo.show(output:str, console:AirflowConsole | None=None) -> None

Show information about Airflow instance.

classairflow-core.src.airflow.cli.commands.info_command.Anonymizer

Anonymizer protocol.

methodairflow-core.src.airflow.cli.commands.info_command.Anonymizer.process_path(value) -> str

Remove pii from paths.

methodairflow-core.src.airflow.cli.commands.info_command.Anonymizer.process_url(value) -> str

Remove pii from URL.

methodairflow-core.src.airflow.cli.commands.info_command.Anonymizer.process_username(value) -> str

Remove pii from username.

classairflow-core.src.airflow.cli.commands.info_command.Architecture

Compute architecture.

methodairflow-core.src.airflow.cli.commands.info_command.Architecture.get_current() -> Architecture

Get architecture.

classairflow-core.src.airflow.cli.commands.info_command.NullAnonymizer

Do nothing.

classairflow-core.src.airflow.cli.commands.info_command.OperatingSystem

Operating system.

methodairflow-core.src.airflow.cli.commands.info_command.OperatingSystem.get_current() -> OperatingSystem

Get current operating system.

classairflow-core.src.airflow.cli.commands.info_command.PiiAnonymizer

Remove personally identifiable info from path.

funcairflow-core.src.airflow.cli.commands.jobs_command.check(args, *session:Session=NEW_SESSION) -> None

Check if job(s) are still alive.

funcairflow-core.src.airflow.cli.commands.partition_command.clear(args, *session:Session=NEW_SESSION) -> None

Clear the partition_key and partition_date of matching DagRuns.

funcairflow-core.src.airflow.cli.commands.plugins_command.dump_plugins(args)

Dump plugins information.

funcairflow-core.src.airflow.cli.commands.pool_command.pool_delete(args)

Delete pool by a given name.

funcairflow-core.src.airflow.cli.commands.pool_command.pool_import(args)

Import pools from the file.

funcairflow-core.src.airflow.cli.commands.pool_command.pool_list(args)

Display info of all the pools.

funcairflow-core.src.airflow.cli.commands.provider_command.connection_field_behaviours(args)

List field behaviours.

funcairflow-core.src.airflow.cli.commands.provider_command.provider_get(args)

Get a provider info.

funcairflow-core.src.airflow.cli.commands.scheduler_command.scheduler(args:Namespace)

Start Airflow Scheduler.

classairflow-core.src.airflow.cli.commands.standalone_command.SubCommand

Execute a subcommand on another thread.

funcairflow-core.src.airflow.cli.commands.task_command.task_list(args, dag:DAG | None=None) -> None

List the tasks within a DAG at the command line.

funcairflow-core.src.airflow.cli.commands.task_command.task_render(args, dag:DAG | None=None) -> None

Render and displays templated fields for a given task.

funcairflow-core.src.airflow.cli.commands.task_command.task_states_for_dag_run(args, *session:Session=NEW_SESSION) -> None

Get the status of all task instances in a DagRun.

funcairflow-core.src.airflow.cli.commands.task_command.task_test(args, dag:DAG | None=None) -> None

Test task for a given dag_id.

funcairflow-core.src.airflow.cli.commands.team_command.team_create(args, *session=NEW_SESSION)

Create a new team.

funcairflow-core.src.airflow.cli.commands.team_command.team_list(args, *session=NEW_SESSION)

List all teams.

funcairflow-core.src.airflow.cli.commands.triggerer_command.triggerer(args)

Start Airflow Triggerer.

funcairflow-core.src.airflow.cli.commands.variable_command.variables_list(args)

Display all the variables.

funcairflow-core.src.airflow.cli.hot_reload.signal_handler(signum, frame)

Handle termination signals.

funcairflow-core.src.airflow.cli.hot_reload.start_process()

Start or restart the subprocess.

classairflow-core.src.airflow.cli.simple_table.AirflowConsole

Airflow rich console.

methodairflow-core.src.airflow.cli.simple_table.AirflowConsole.print_as_table(data:list[dict])

Render list of dictionaries as table.

classairflow-core.src.airflow.cli.simple_table.SimpleTable

A rich Table with some default hardcoded for consistency.

methodairflow-core.src.airflow.cli.simple_table.SimpleTable.add_column(*args, **kwargs) -> None

Add a column to the table.

funcairflow-core.src.airflow.cli.utils.is_stdout(fileio:IOBase) -> bool

Check whether a file IO is stdout.

func

airflow-core.src.airflow.configuration.ensure_secrets_loaded(default_backends:list[str]=DEFAULT_SECRETS_SEARCH_PATH) -> list[BaseSecretsBackend]

Ensure that all secrets backends are loaded.

funcairflow-core.src.airflow.configuration.get_airflow_config(airflow_home:str) -> str

Get Path to airflow.cfg path.

funcairflow-core.src.airflow.configuration.get_airflow_home() -> str

Get path to Airflow Home.

funcairflow-core.src.airflow.configuration.get_custom_secret_backend(worker_mode:bool=False) -> BaseSecretsBackend | None

Get Secret Backend if defined in airflow.cfg.

funcairflow-core.src.airflow.configuration.initialize_auth_manager() -> BaseAuthManager

Initialize auth manager.

funcairflow-core.src.airflow.configuration.initialize_config() -> AirflowConfigParser

Load the Airflow config files.

func

airflow-core.src.airflow.configuration.initialize_secrets_backends(default_backends:list[str]=DEFAULT_SECRETS_SEARCH_PATH) -> list[BaseSecretsBackend]

Initialize secrets backend.

funcairflow-core.src.airflow.configuration.run_command(command:str) -> str

Run command and returns stdout.

classairflow-core.src.airflow.dag_processing.bundles.base.BaseDagBundle

Base class for DAG bundles.

methodairflow-core.src.airflow.dag_processing.bundles.base.BaseDagBundle.initialize() -> None

Initialize the bundle.

methodairflow-core.src.airflow.dag_processing.bundles.base.BaseDagBundle.path() -> Path

Path for this bundle.

methodairflow-core.src.airflow.dag_processing.bundles.base.BaseDagBundle.view_url(version:str | None=None) -> str | None

URL to view the bundle on an external website.

classairflow-core.src.airflow.dag_processing.bundles.base.BundleUsageTrackingManager

Utility helper for removing stale bundles.

classairflow-core.src.airflow.dag_processing.bundles.base.BundleVersion

Version information returned by a DAG bundle.

classairflow-core.src.airflow.dag_processing.bundles.base.TrackedBundleVersionInfo

Internal info class for stale bundle cleanup.

classairflow-core.src.airflow.dag_processing.bundles.manager.DagBundlesManager

Manager for DAG bundles.

methodairflow-core.src.airflow.dag_processing.bundles.manager.DagBundlesManager.get_all_bundle_names() -> Iterable[str]

Get all bundle names.

method

airflow-core.src.airflow.dag_processing.bundles.manager.DagBundlesManager.get_all_dag_bundles() -> Iterable[BaseDagBundle]

Get all DAG bundles.

method

airflow-core.src.airflow.dag_processing.bundles.manager.DagBundlesManager.get_bundle(name:str, version:str | None=None, version_data:dict[str, Any] | None=None) -> BaseDagBundle

Get a DAG bundle by name.

classairflow-core.src.airflow.dag_processing.dagbag.BundleDagBag

Bundle-aware DagBag that permanently modifies sys.path.

classairflow-core.src.airflow.dag_processing.dagbag.FileLoadStat

Information about single file.

classairflow-core.src.airflow.dag_processing.importers.base.AbstractDagImporter

Abstract base class for DAG importers.

methodairflow-core.src.airflow.dag_processing.importers.base.AbstractDagImporter.can_handle(file_path:str | Path) -> bool

Check if this importer can handle the given file.

method

airflow-core.src.airflow.dag_processing.importers.base.AbstractDagImporter.import_file(file_path:str | Path, *bundle_path:Path | None=None, *bundle_name:str | None=None, *safe_mode:bool=True) -> DagImportResult

Import DAGs from a file.

classairflow-core.src.airflow.dag_processing.importers.base.DagImportResult

Result of importing DAGs from a file.

methodairflow-core.src.airflow.dag_processing.importers.base.DagImportResult.success() -> bool

Return True if no fatal errors occurred.

classairflow-core.src.airflow.dag_processing.importers.base.DagImporterRegistry

Registry for DAG importers.

method

airflow-core.src.airflow.dag_processing.importers.base.DagImporterRegistry.register(importer:AbstractDagImporter) -> None

methodairflow-core.src.airflow.dag_processing.importers.base.DagImporterRegistry.reset() -> None

Reset the singleton (for testing).

classairflow-core.src.airflow.dag_processing.manager.BundleState

Persisted refresh state for a DAG bundle.

classairflow-core.src.airflow.dag_processing.manager.DagFileInfo

Information about a DAG file.

classairflow-core.src.airflow.dag_processing.manager.DagFileProcessorManager

Manage processes responsible for parsing DAGs.

methodairflow-core.src.airflow.dag_processing.manager.DagFileProcessorManager.terminate()

Stop all running processors.

classairflow-core.src.airflow.dag_processing.manager.DagFileStat

Information about single processing of one file.

classairflow-core.src.airflow.dag_processing.manager.DagParsingStat

Information on processing progress.

classairflow-core.src.airflow.dag_processing.processor.DagFileParseRequest

Request for DAG File Parsing.

classairflow-core.src.airflow.dag_processing.processor.DagFileParsingResult

Result of DAG File Parsing.

classairflow-core.src.airflow.dag_processing.processor.DagFileProcessorProcess

Parses dags with Task SDK API.

classairflow-core.src.airflow.example_dags.example_skip_dag.EmptySkipOperator

Empty operator which always skips the task.

funcairflow-core.src.airflow.example_dags.example_task_group_decorator.task_1(value:int) -> str

Empty Task1

funcairflow-core.src.airflow.example_dags.example_task_group_decorator.task_2(value:str) -> str

Empty Task2

funcairflow-core.src.airflow.example_dags.example_task_group_decorator.task_3(value:str) -> None

Empty Task3

funcairflow-core.src.airflow.example_dags.example_task_group_decorator.task_end() -> None

Empty Task which is Last Task of Dag

funcairflow-core.src.airflow.example_dags.example_task_group_decorator.task_group_function(value:int) -> None

TaskGroup for grouping related Tasks

funcairflow-core.src.airflow.example_dags.example_task_state_store_mapped.get_tables() -> list[str]

Return the list of tables to process.

funcairflow-core.src.airflow.example_dags.example_xcomargs.generate_value()

Empty function

funcairflow-core.src.airflow.example_dags.example_xcomargs.print_value(value, ts=None)

Empty function

classairflow-core.src.airflow.exceptions.AirflowBadRequest

Raise when the application or server cannot handle the request.

この情報について

掲載しているシグネチャは apache/airflow の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る