Go API client for airflow

Apache Airflow management API.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 0.1.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://airflow.apache.org

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./airflow"

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

Class	Method	HTTP request	Description
ConfigApi	GetConfig	Get /config	Get current configuration
ConnectionApi	DeleteConnection	Delete /connections/{connection_id}	Delete a connection entry
ConnectionApi	GetConnection	Get /connections/{connection_id}	Get a connection entry
ConnectionApi	GetConnections	Get /connections	Get all connection entries
ConnectionApi	PatchConnection	Patch /connections/{connection_id}	Update a connection entry
ConnectionApi	PostConnection	Post /connections	Create connection entry
DAGApi	GetDag	Get /dags/{dag_id}	Get basic information about a DAG
DAGApi	GetDagDetails	Get /dags/{dag_id}/details	Get a simplified representation of DAG.
DAGApi	GetDagSource	Get /dagSources/{file_token}	Get source code using file token
DAGApi	GetDags	Get /dags	Get all DAGs
DAGApi	GetTask	Get /dags/{dag_id}/tasks/{task_id}	Get simplified representation of a task.
DAGApi	GetTasks	Get /dags/{dag_id}/tasks	Get tasks for DAG
DAGApi	PatchDag	Patch /dags/{dag_id}	Update a DAG
DAGApi	PostClearTaskInstances	Post /dags/{dag_id}/clearTaskInstances	Clears a set of task instances associated with the DAG for a specified date range.
DAGRunApi	DeleteDagRun	Delete /dags/{dag_id}/dagRuns/{dag_run_id}	Delete a DAG Run
DAGRunApi	GetDagRun	Get /dags/{dag_id}/dagRuns/{dag_run_id}	Get a DAG Run
DAGRunApi	GetDagRuns	Get /dags/{dag_id}/dagRuns	Get all DAG Runs
DAGRunApi	GetDagRunsBatch	Post /dags/~/dagRuns/list	Get all DAG Runs from aall DAGs.
DAGRunApi	PatchDagRun	Patch /dags/{dag_id}/dagRuns/{dag_run_id}	Update a DAG Run
DAGRunApi	PostDagRun	Post /dags/{dag_id}/dagRuns/{dag_run_id}	Trigger a DAG Run
EventLogApi	GetEventLog	Get /eventLogs/{event_log_id}	Get a log entry
EventLogApi	GetEventLogs	Get /eventLogs	Get all log entries from event log
ImportErrorApi	GetImportError	Get /importErrors/{import_error_id}	Get an import error
ImportErrorApi	GetImportErrors	Get /importErrors	Get all import errors
MonitoringApi	GetHealth	Get /health	Checks if the API works
MonitoringApi	GetVersion	Get /version	Get version information
PoolApi	DeletePool	Delete /pools/{pool_name}	Delete a pool
PoolApi	GetPool	Get /pools/{pool_name}	Get a pool
PoolApi	GetPools	Get /pools	Get all pools
PoolApi	PatchPool	Patch /pools/{pool_name}	Update a pool
PoolApi	PostPool	Post /pools	Create a pool
TaskInstanceApi	GetExtraLinks	Get /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links	Get extra links for task instance
TaskInstanceApi	GetLog	Get /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number}	Get logs for a task instance
TaskInstanceApi	GetTaskInstance	Get /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}	Get a task instance
TaskInstanceApi	GetTaskInstances	Get /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances	Get a list of task instance of DAG.
TaskInstanceApi	GetTaskInstancesBatch	Post /dags//dagRuns//taskInstances/list	Get list of task instances from all DAGs and DAG Runs.
VariableApi	DeleteVariable	Delete /variables/{variable_key}	Delete variable
VariableApi	GetVariable	Get /variables/{variable_key}	Get a variable by key
VariableApi	GetVariables	Get /variables	Get all variables
VariableApi	PatchVariable	Patch /variables/{variable_key}	Update a variable by key
VariableApi	PostVariables	Post /variables	Create a variable
XComApi	DeleteXcomEntry	Delete /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}	Delete an XCom entry
XComApi	GetXcomEntries	Get /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries	Get all XCom entries
XComApi	GetXcomEntry	Get /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}	Get an XCom entry
XComApi	PatchXcomEntry	Patch /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}	Update an XCom entry
XComApi	PostXcomEntries	Post /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries	Create an XCom entry

Documentation For Models

• ClassReference
• ClearTaskInstance
• CollectionInfo
• Config
• ConfigOption
• ConfigSection
• Connection
• ConnectionAllOf
• ConnectionCollection
• ConnectionCollectionItem
• CronExpression
• Dag
• DagCollection
• DagDetail
• DagDetailAllOf
• DagRun
• DagRunCollection
• DagState
• Error
• EventLog
• EventLogCollection
• ExtraLink
• ExtraLinkCollection
• ImportError
• ImportErrorCollection
• InlineResponse200
• InlineResponse2001
• ListDagRunsForm
• ListTaskInstanceForm
• Pool
• PoolCollection
• RelativeDelta
• ScheduleInterval
• SlaMiss
• SlaMissCollection
• Tag
• Task
• TaskCollection
• TaskExtraLinks
• TaskFail
• TaskInstance
• TaskInstanceCollection
• TaskInstanceReference
• TaskInstanceReferenceCollection
• TaskState
• TimeDelta
• TriggerRule
• Variable
• VariableAllOf
• VariableCollection
• VariableCollectionItem
• VersionInfo
• WeightRule
• XCom
• XComCollection
• XComCollectionItem

Documentation For Authorization

Endpoints do not require authorization.

Author

[email protected]