airflow

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 24, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

README

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: 1.0.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

Documentation For Authorization

Endpoints do not require authorization.

Author

dev@airflow.apache.org

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	ConfigApi *ConfigApiService

	ConnectionApi *ConnectionApiService

	DAGApi *DAGApiService

	DAGRunApi *DAGRunApiService

	EventLogApi *EventLogApiService

	ImportErrorApi *ImportErrorApiService

	MonitoringApi *MonitoringApiService

	PoolApi *PoolApiService

	TaskInstanceApi *TaskInstanceApiService

	VariableApi *VariableApiService

	XComApi *XComApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Airflow API (Stable) API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type ClassReference 

type ClassReference struct {
	ModulePath string `json:"module_path,omitempty"`
	ClassName  string `json:"class_name,omitempty"`
}

ClassReference struct for ClassReference

type ClearTaskInstance 

type ClearTaskInstance struct {
	// If set, don't actually run this operation. The response will contain a list of task instances planned to be cleaned, but not modified in any way.
	DryRun bool `json:"dry_run,omitempty"`
	// The minimum execution date to clear.
	StartDate string `json:"start_date,omitempty"`
	// The maximum execution date to clear.
	EndDate string `json:"end_date,omitempty"`
	// Only clear failed tasks.
	OnlyFailed string `json:"only_failed,omitempty"`
	// Only clear running tasks.
	OnlyRunning string `json:"only_running,omitempty"`
	// Clear tasks in subdags and clear external tasks indicated by ExternalTaskMarker.
	IncludeSubdags bool `json:"include_subdags,omitempty"`
	// Clear tasks in the parent dag of the subdag.
	IncludeParentdag bool `json:"include_parentdag,omitempty"`
	// Set state of DAG Runs to RUNNING.
	ResetDagRuns bool `json:"reset_dag_runs,omitempty"`
}

ClearTaskInstance struct for ClearTaskInstance

type CollectionInfo 

type CollectionInfo struct {
	// Total count for all collection items.
	TotalEntries int32 `json:"total_entries,omitempty"`
}

CollectionInfo struct for CollectionInfo

type Config 

type Config struct {
	Sections []ConfigSection `json:"sections,omitempty"`
}

Config struct for Config

type ConfigApiService 

type ConfigApiService service

ConfigApiService ConfigApi service

func (*ConfigApiService) GetConfig 

func (a *ConfigApiService) GetConfig(ctx _context.Context, localVarOptionals *GetConfigOpts) (Config, *_nethttp.Response, error)

GetConfig Get current configuration

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetConfigOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.

@return Config

type ConfigOption 

type ConfigOption struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

ConfigOption struct for ConfigOption

type ConfigSection 

type ConfigSection struct {
	Name    string         `json:"name,omitempty"`
	Options []ConfigOption `json:"options,omitempty"`
}

ConfigSection struct for ConfigSection

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type Connection 

type Connection struct {
	ConnectionId string  `json:"connection_id,omitempty"`
	ConnType     string  `json:"conn_type,omitempty"`
	Host         *string `json:"host,omitempty"`
	Login        *string `json:"login,omitempty"`
	Schema       *string `json:"schema,omitempty"`
	Port         *int32  `json:"port,omitempty"`
	Password     string  `json:"password,omitempty"`
	Extra        *string `json:"extra,omitempty"`
}

Connection struct for Connection

type ConnectionAllOf 

type ConnectionAllOf struct {
	Password string  `json:"password,omitempty"`
	Extra    *string `json:"extra,omitempty"`
}

ConnectionAllOf struct for ConnectionAllOf

type ConnectionApiService 

type ConnectionApiService service

ConnectionApiService ConnectionApi service

func (*ConnectionApiService) DeleteConnection 

func (a *ConnectionApiService) DeleteConnection(ctx _context.Context, connectionId string) (*_nethttp.Response, error)

DeleteConnection Delete a connection entry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectionId The Connection ID.

func (*ConnectionApiService) GetConnection 

func (a *ConnectionApiService) GetConnection(ctx _context.Context, connectionId string) (Connection, *_nethttp.Response, error)

GetConnection Get a connection entry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectionId The Connection ID.

@return Connection

func (*ConnectionApiService) GetConnections 

func (a *ConnectionApiService) GetConnections(ctx _context.Context, localVarOptionals *GetConnectionsOpts) (ConnectionCollection, *_nethttp.Response, error)

GetConnections Get all connection entries

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetConnectionsOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.

@return ConnectionCollection

func (*ConnectionApiService) PatchConnection 

func (a *ConnectionApiService) PatchConnection(ctx _context.Context, connectionId string, connection Connection, localVarOptionals *PatchConnectionOpts) (Connection, *_nethttp.Response, error)

PatchConnection Update a connection entry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectionId The Connection ID.
  • @param connection
  • @param optional nil or *PatchConnectionOpts - Optional Parameters:
  • @param "UpdateMask" (optional.Interface of []string) - The fields to update on the connection (connection, pool etc). If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields.

@return Connection

func (*ConnectionApiService) PostConnection 

func (a *ConnectionApiService) PostConnection(ctx _context.Context, connection Connection) (Connection, *_nethttp.Response, error)

PostConnection Create connection entry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connection

@return Connection

type ConnectionCollection 

type ConnectionCollection struct {
	Connections []ConnectionCollectionItem `json:"connections,omitempty"`
}

ConnectionCollection struct for ConnectionCollection

type ConnectionCollectionItem 

type ConnectionCollectionItem struct {
	ConnectionId string  `json:"connection_id,omitempty"`
	ConnType     string  `json:"conn_type,omitempty"`
	Host         *string `json:"host,omitempty"`
	Login        *string `json:"login,omitempty"`
	Schema       *string `json:"schema,omitempty"`
	Port         *int32  `json:"port,omitempty"`
}

ConnectionCollectionItem struct for ConnectionCollectionItem

type CronExpression 

type CronExpression struct {
	Type  string `json:"__type"`
	Value string `json:"value,omitempty"`
}

CronExpression struct for CronExpression

type DAGApiService 

type DAGApiService service

DAGApiService DAGApi service

func (*DAGApiService) GetDag 

func (a *DAGApiService) GetDag(ctx _context.Context, dagId string) (Dag, *_nethttp.Response, error)

GetDag Get basic information about a DAG Presents only information available in database (DAGModel). If you need detailed information, consider using GET /dags/{dag_id}/detail.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.

@return Dag

func (*DAGApiService) GetDagDetails 

func (a *DAGApiService) GetDagDetails(ctx _context.Context, dagId string) (DagDetail, *_nethttp.Response, error)

GetDagDetails Get a simplified representation of DAG. The response contains many DAG attributes, so the response can be large. If possible, consider using GET /dags/{dag_id}.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.

@return DagDetail

func (*DAGApiService) GetDagSource 

func (a *DAGApiService) GetDagSource(ctx _context.Context, fileToken string) (InlineResponse2001, *_nethttp.Response, error)

GetDagSource Get source code using file token

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fileToken The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change.

@return InlineResponse2001

func (*DAGApiService) GetDags 

func (a *DAGApiService) GetDags(ctx _context.Context, localVarOptionals *GetDagsOpts) (DagCollection, *_nethttp.Response, error)

GetDags Get all DAGs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetDagsOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.

@return DagCollection

func (*DAGApiService) GetTask 

func (a *DAGApiService) GetTask(ctx _context.Context, dagId string, taskId string) (Task, *_nethttp.Response, error)

GetTask Get simplified representation of a task.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param taskId The Task ID.

@return Task

func (*DAGApiService) GetTasks 

func (a *DAGApiService) GetTasks(ctx _context.Context, dagId string) (TaskCollection, *_nethttp.Response, error)

GetTasks Get tasks for DAG

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.

@return TaskCollection

func (*DAGApiService) PatchDag 

func (a *DAGApiService) PatchDag(ctx _context.Context, dagId string, dag Dag) (Dag, *_nethttp.Response, error)

PatchDag Update a DAG

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dag

@return Dag

func (*DAGApiService) PostClearTaskInstances 

func (a *DAGApiService) PostClearTaskInstances(ctx _context.Context, dagId string, clearTaskInstance ClearTaskInstance) (TaskInstanceReferenceCollection, *_nethttp.Response, error)

PostClearTaskInstances Clears a set of task instances associated with the DAG for a specified date range.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param clearTaskInstance Parameters of action

@return TaskInstanceReferenceCollection

type DAGRunApiService 

type DAGRunApiService service

DAGRunApiService DAGRunApi service

func (*DAGRunApiService) DeleteDagRun 

func (a *DAGRunApiService) DeleteDagRun(ctx _context.Context, dagId string, dagRunId string) (*_nethttp.Response, error)

DeleteDagRun Delete a DAG Run

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.

func (*DAGRunApiService) GetDagRun 

func (a *DAGRunApiService) GetDagRun(ctx _context.Context, dagId string, dagRunId string) (DagRun, *_nethttp.Response, error)

GetDagRun Get a DAG Run

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.

@return DagRun

func (*DAGRunApiService) GetDagRuns 

func (a *DAGRunApiService) GetDagRuns(ctx _context.Context, dagId string, localVarOptionals *GetDagRunsOpts) (DagRunCollection, *_nethttp.Response, error)

GetDagRuns Get all DAG Runs This endpoint allows specifying `~` as the dag_id to retrieve DAG Runs for all DAGs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param optional nil or *GetDagRunsOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.
  • @param "ExecutionDateGte" (optional.Time) - Returns objects greater or equal to the specified date. This can be combined with execution_date_lte parameter to receive only the selected period.
  • @param "ExecutionDateLte" (optional.Time) - Returns objects less than or equal to the specified date. This can be combined with execution_date_gte parameter to receive only the selected period.
  • @param "StartDateGte" (optional.Time) - Returns objects greater or equal the specified date. This can be combined with startd_ate_lte parameter to receive only the selected period.
  • @param "StartDateLte" (optional.Time) - Returns objects less or equal the specified date. This can be combined with start_date_gte parameter to receive only the selected period.
  • @param "EndDateGte" (optional.Time) - Returns objects greater or equal the specified date. This can be combined with start_date_lte parameter to receive only the selected period.
  • @param "EndDateLte" (optional.Time) - Returns objects less than or equal to the specified date. This can be combined with start_date_gte parameter to receive only the selected period.

@return DagRunCollection

func (*DAGRunApiService) GetDagRunsBatch 

func (a *DAGRunApiService) GetDagRunsBatch(ctx _context.Context, listDagRunsForm ListDagRunsForm) (DagRunCollection, *_nethttp.Response, error)

GetDagRunsBatch Get all DAG Runs from aall DAGs. This endpoint is a POST to allow filtering across a large number of DAG IDs, where as a GET it would run in to maximum HTTP request URL lengthlimits

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param listDagRunsForm

@return DagRunCollection

func (*DAGRunApiService) PatchDagRun 

func (a *DAGRunApiService) PatchDagRun(ctx _context.Context, dagId string, dagRunId string, dagRun DagRun, localVarOptionals *PatchDagRunOpts) (DagRun, *_nethttp.Response, error)

PatchDagRun Update a DAG Run

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param dagRun
  • @param optional nil or *PatchDagRunOpts - Optional Parameters:
  • @param "UpdateMask" (optional.Interface of []string) - The fields to update on the connection (connection, pool etc). If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields.

@return DagRun

func (*DAGRunApiService) PostDagRun 

func (a *DAGRunApiService) PostDagRun(ctx _context.Context, dagId string, dagRunId string, dagRun DagRun) (DagRun, *_nethttp.Response, error)

PostDagRun Trigger a DAG Run

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param dagRun

@return DagRun

type Dag 

type Dag struct {
	DagId     string `json:"dag_id,omitempty"`
	RootDagId string `json:"root_dag_id,omitempty"`
	IsPaused  bool   `json:"is_paused,omitempty"`
	IsSubdag  bool   `json:"is_subdag,omitempty"`
	Fileloc   string `json:"fileloc,omitempty"`
	// The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change.
	FileToken        string           `json:"file_token,omitempty"`
	Owners           []string         `json:"owners,omitempty"`
	Description      string           `json:"description,omitempty"`
	ScheduleInterval ScheduleInterval `json:"schedule_interval,omitempty"`
	Tags             []Tag            `json:"tags,omitempty"`
}

Dag struct for Dag

type DagCollection 

type DagCollection struct {
	Dags []Dag `json:"dags,omitempty"`
}

DagCollection struct for DagCollection

type DagDetail 

type DagDetail struct {
	DagId     string `json:"dag_id,omitempty"`
	RootDagId string `json:"root_dag_id,omitempty"`
	IsPaused  bool   `json:"is_paused,omitempty"`
	IsSubdag  bool   `json:"is_subdag,omitempty"`
	Fileloc   string `json:"fileloc,omitempty"`
	// The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change.
	FileToken        string           `json:"file_token,omitempty"`
	Owners           []string         `json:"owners,omitempty"`
	Description      string           `json:"description,omitempty"`
	ScheduleInterval ScheduleInterval `json:"schedule_interval,omitempty"`
	Tags             []Tag            `json:"tags,omitempty"`
	Timezone         string           `json:"timezone,omitempty"`
	Catchup          bool             `json:"catchup,omitempty"`
	Orientation      string           `json:"orientation,omitempty"`
	Concurrency      float32          `json:"concurrency,omitempty"`
	StartDate        time.Time        `json:"start_date,omitempty"`
	DagRunTimeout    TimeDelta        `json:"dag_run_timeout,omitempty"`
	DocMd            string           `json:"doc_md,omitempty"`
	DefaultView      string           `json:"default_view,omitempty"`
}

DagDetail struct for DagDetail

type DagDetailAllOf 

type DagDetailAllOf struct {
	Timezone      string    `json:"timezone,omitempty"`
	Catchup       bool      `json:"catchup,omitempty"`
	Orientation   string    `json:"orientation,omitempty"`
	Concurrency   float32   `json:"concurrency,omitempty"`
	StartDate     time.Time `json:"start_date,omitempty"`
	DagRunTimeout TimeDelta `json:"dag_run_timeout,omitempty"`
	DocMd         string    `json:"doc_md,omitempty"`
	DefaultView   string    `json:"default_view,omitempty"`
}

DagDetailAllOf struct for DagDetailAllOf

type DagRun 

type DagRun struct {
	// Run ID. The value of this field can be set only when creating the object. If you try to modify the field of an existing object, the request fails with an BAD_REQUEST error. If not provided, a value will be generated based on execution_date. If the specified dag_run_id is in use, the creation request fails with an ALREADY_EXISTS error. This together with DAG_ID are a unique key.
	DagRunId string `json:"dag_run_id,omitempty"`
	DagId    string `json:"dag_id"`
	// The execution date. This is the time when the DAG run should be started according to the DAG definition. The value of this field can be set only when creating the object. If you try to modify the field of an existing object, the request fails with an BAD_REQUEST error. This together with DAG_ID are a unique key.
	ExecutionDate time.Time `json:"execution_date,omitempty"`
	// The start time. The time when DAG Run was actually created..
	StartDate       time.Time  `json:"start_date,omitempty"`
	EndDate         *time.Time `json:"end_date,omitempty"`
	State           DagState   `json:"state,omitempty"`
	ExternalTrigger bool       `json:"external_trigger,omitempty"`
	// JSON object describing additional configuration parameters. The value of this field can be set only when creating the object. If you try to modify the field of an existing object, the request fails with an BAD_REQUEST error.
	Conf map[string]interface{} `json:"conf,omitempty"`
}

DagRun struct for DagRun

type DagRunCollection 

type DagRunCollection struct {
	DagRuns []DagRun `json:"dag_runs,omitempty"`
}

DagRunCollection struct for DagRunCollection

type DagState 

type DagState string

DagState the model 'DagState' 

const (
	DAGSTATE_SUCCESS DagState = "success"
	DAGSTATE_RUNNING DagState = "running"
	DAGSTATE_FAILED  DagState = "failed"
)

List of DagState

type Error 

type Error struct {
	// A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type.
	Type string `json:"type"`
	// A short, human-readable summary of the problem  type.
	Title string `json:"title"`
	// The HTTP status code generated by the API server for this occurrence of the problem.
	Status float32 `json:"status"`
	// A human-readable explanation specific to this occurrence of the problem.
	Detail string `json:"detail,omitempty"`
	// A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
	Instance string `json:"instance,omitempty"`
}

Error [RFC7807](https://tools.ietf.org/html/rfc7807) compliant response

type EventLog 

type EventLog struct {
	EventLogId    int32   `json:"event_log_id,omitempty"`
	When          string  `json:"when,omitempty"`
	DagId         string  `json:"dag_id,omitempty"`
	TaskId        string  `json:"task_id,omitempty"`
	Event         string  `json:"event,omitempty"`
	ExecutionDate string  `json:"execution_date,omitempty"`
	Owner         string  `json:"owner,omitempty"`
	Extra         *string `json:"extra,omitempty"`
}

EventLog struct for EventLog

type EventLogApiService 

type EventLogApiService service

EventLogApiService EventLogApi service

func (*EventLogApiService) GetEventLog 

func (a *EventLogApiService) GetEventLog(ctx _context.Context, eventLogId int32) (EventLog, *_nethttp.Response, error)

GetEventLog Get a log entry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param eventLogId The Event Log ID.

@return EventLog

func (*EventLogApiService) GetEventLogs 

func (a *EventLogApiService) GetEventLogs(ctx _context.Context, localVarOptionals *GetEventLogsOpts) (EventLogCollection, *_nethttp.Response, error)

GetEventLogs Get all log entries from event log

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetEventLogsOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.

@return EventLogCollection

type EventLogCollection 

type EventLogCollection struct {
	EventLogs []EventLog `json:"event_logs,omitempty"`
}

EventLogCollection struct for EventLogCollection 

type ExtraLink struct {
	ClassRef ClassReference `json:"class_ref,omitempty"`
	Name     string         `json:"name,omitempty"`
	Href     string         `json:"href,omitempty"`
}

ExtraLink struct for ExtraLink

type ExtraLinkCollection 

type ExtraLinkCollection struct {
	ExtraLinks []ExtraLink `json:"extra_links,omitempty"`
}

ExtraLinkCollection struct for ExtraLinkCollection

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetConfigOpts 

type GetConfigOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

GetConfigOpts Optional parameters for the method 'GetConfig'

type GetConnectionsOpts 

type GetConnectionsOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

GetConnectionsOpts Optional parameters for the method 'GetConnections'

type GetDagRunsOpts 

type GetDagRunsOpts struct {
	Limit            optional.Int32
	Offset           optional.Int32
	ExecutionDateGte optional.Time
	ExecutionDateLte optional.Time
	StartDateGte     optional.Time
	StartDateLte     optional.Time
	EndDateGte       optional.Time
	EndDateLte       optional.Time
}

GetDagRunsOpts Optional parameters for the method 'GetDagRuns'

type GetDagsOpts 

type GetDagsOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

GetDagsOpts Optional parameters for the method 'GetDags'

type GetEventLogsOpts 

type GetEventLogsOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

GetEventLogsOpts Optional parameters for the method 'GetEventLogs'

type GetImportErrorsOpts 

type GetImportErrorsOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

GetImportErrorsOpts Optional parameters for the method 'GetImportErrors'

type GetLogOpts 

type GetLogOpts struct {
	FullContent optional.Bool
	Token       optional.String
}

GetLogOpts Optional parameters for the method 'GetLog'

type GetPoolsOpts 

type GetPoolsOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

GetPoolsOpts Optional parameters for the method 'GetPools'

type GetTaskInstancesOpts 

type GetTaskInstancesOpts struct {
	ExecutionDateGte optional.Time
	ExecutionDateLte optional.Time
	StartDateGte     optional.Time
	StartDateLte     optional.Time
	EndDateGte       optional.Time
	EndDateLte       optional.Time
	DurationGte      optional.Float32
	DurationLte      optional.Float32
	State            optional.Interface
	Pool             optional.Interface
	Queue            optional.Interface
	Limit            optional.Int32
	Offset           optional.Int32
}

GetTaskInstancesOpts Optional parameters for the method 'GetTaskInstances'

type GetVariablesOpts 

type GetVariablesOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

GetVariablesOpts Optional parameters for the method 'GetVariables'

type GetXcomEntriesOpts 

type GetXcomEntriesOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

GetXcomEntriesOpts Optional parameters for the method 'GetXcomEntries'

type ImportError 

type ImportError struct {
	ImportErrorId int32  `json:"import_error_id,omitempty"`
	Timestamp     string `json:"timestamp,omitempty"`
	Filename      string `json:"filename,omitempty"`
	StackTrace    string `json:"stack_trace,omitempty"`
}

ImportError struct for ImportError

type ImportErrorApiService 

type ImportErrorApiService service

ImportErrorApiService ImportErrorApi service

func (*ImportErrorApiService) GetImportError 

func (a *ImportErrorApiService) GetImportError(ctx _context.Context, importErrorId int32) (ImportError, *_nethttp.Response, error)

GetImportError Get an import error

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param importErrorId The Import Error ID.

@return ImportError

func (*ImportErrorApiService) GetImportErrors 

func (a *ImportErrorApiService) GetImportErrors(ctx _context.Context, localVarOptionals *GetImportErrorsOpts) (ImportErrorCollection, *_nethttp.Response, error)

GetImportErrors Get all import errors

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetImportErrorsOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.

@return ImportErrorCollection

type ImportErrorCollection 

type ImportErrorCollection struct {
	ImportErrors []ImportError `json:"import_errors,omitempty"`
}

ImportErrorCollection struct for ImportErrorCollection

type InlineResponse200 

type InlineResponse200 struct {
	ContinuationToken string `json:"continuation_token,omitempty"`
	Content           string `json:"content,omitempty"`
}

InlineResponse200 struct for InlineResponse200

type InlineResponse2001 

type InlineResponse2001 struct {
	Content string `json:"content,omitempty"`
}

InlineResponse2001 struct for InlineResponse2001

type ListDagRunsForm 

type ListDagRunsForm struct {
	// The number of items to skip before starting to collect the result set.
	PageOffset int32 `json:"page_offset,omitempty"`
	// The numbers of items to return.
	PageLimit int32 `json:"page_limit,omitempty"`
	// Return objects with specific DAG IDs. The value can be repeated to retrieve multiple matching values (OR condition).
	DagIds []string `json:"dag_ids,omitempty"`
	// Returns objects greater or equal to the specified date. This can be combined with execution_date_lte key to receive only the selected period.
	ExecutionDateGte time.Time `json:"execution_date_gte,omitempty"`
	// Returns objects less than or equal to the specified date. This can be combined with execution_date_gte key to receive only the selected period.
	ExecutionDateLte time.Time `json:"execution_date_lte,omitempty"`
	// Returns objects greater or equal the specified date. This can be combined with start_date_lte key to receive only the selected period.
	StartDateGte time.Time `json:"start_date_gte,omitempty"`
	// Returns objects less or equal the specified date. This can be combined with start_date_gte parameter to receive only the selected period
	StartDateLte time.Time `json:"start_date_lte,omitempty"`
	// Returns objects greater or equal the specified date. This can be combined with end_date_lte parameter to receive only the selected period.
	EndDateGte time.Time `json:"end_date_gte,omitempty"`
	// Returns objects less than or equal to the specified date. This can be combined with end_date_gte parameter to receive only the selected period.
	EndDateLte time.Time `json:"end_date_lte,omitempty"`
}

ListDagRunsForm struct for ListDagRunsForm

type ListTaskInstanceForm 

type ListTaskInstanceForm struct {
	// Return objects with specific DAG IDs. The value can be repeated to retrieve multiple matching values (OR condition).
	DagIds []string `json:"dag_ids,omitempty"`
	// Returns objects greater or equal to the specified date. This can be combined with execution_date_lte parameter to receive only the selected period.
	ExecutionDateGte time.Time `json:"execution_date_gte,omitempty"`
	// Returns objects less than or equal to the specified date. This can be combined with execution_date_gte parameter to receive only the selected period.
	ExecutionDateLte time.Time `json:"execution_date_lte,omitempty"`
	// Returns objects greater or equal the specified date. This can be combined with startd_ate_lte parameter to receive only the selected period.
	StartDateGte time.Time `json:"start_date_gte,omitempty"`
	// Returns objects less or equal the specified date. This can be combined with start_date_gte parameter to receive only the selected period.
	StartDateLte time.Time `json:"start_date_lte,omitempty"`
	// Returns objects greater or equal the specified date. This can be combined with start_date_lte parameter to receive only the selected period.
	EndDateGte time.Time `json:"end_date_gte,omitempty"`
	// Returns objects less than or equal to the specified date. This can be combined with start_date_gte parameter to receive only the selected period.
	EndDateLte time.Time `json:"end_date_lte,omitempty"`
	// Returns objects greater than or equal to the specified values. This can be combined with duration_lte parameter to receive only the selected period.
	DurationGte float32 `json:"duration_gte,omitempty"`
	// Returns objects less than or equal to the specified values. This can be combined with duration_gte parameter to receive only the selected range.
	DurationLte float32 `json:"duration_lte,omitempty"`
	// The value can be repeated to retrieve multiple matching values (OR condition).
	State []string `json:"State,omitempty"`
	// The value can be repeated to retrieve multiple matching values (OR condition).
	Pool []string `json:"Pool,omitempty"`
	// The value can be repeated to retrieve multiple matching values (OR condition).
	Queue []string `json:"Queue,omitempty"`
}

ListTaskInstanceForm struct for ListTaskInstanceForm

type MonitoringApiService 

type MonitoringApiService service

MonitoringApiService MonitoringApi service

func (*MonitoringApiService) GetHealth 

func (a *MonitoringApiService) GetHealth(ctx _context.Context) (string, *_nethttp.Response, error)

GetHealth Checks if the API works

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*MonitoringApiService) GetVersion 

func (a *MonitoringApiService) GetVersion(ctx _context.Context) (VersionInfo, *_nethttp.Response, error)

GetVersion Get version information

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return VersionInfo

type PatchConnectionOpts 

type PatchConnectionOpts struct {
	UpdateMask optional.Interface
}

PatchConnectionOpts Optional parameters for the method 'PatchConnection'

type PatchDagRunOpts 

type PatchDagRunOpts struct {
	UpdateMask optional.Interface
}

PatchDagRunOpts Optional parameters for the method 'PatchDagRun'

type PatchPoolOpts 

type PatchPoolOpts struct {
	UpdateMask optional.Interface
}

PatchPoolOpts Optional parameters for the method 'PatchPool'

type PatchVariableOpts 

type PatchVariableOpts struct {
	UpdateMask optional.Interface
}

PatchVariableOpts Optional parameters for the method 'PatchVariable'

type PatchXcomEntryOpts 

type PatchXcomEntryOpts struct {
	UpdateMask optional.Interface
}

PatchXcomEntryOpts Optional parameters for the method 'PatchXcomEntry'

type Pool 

type Pool struct {
	Name          string `json:"name,omitempty"`
	Slots         int32  `json:"slots,omitempty"`
	OccupiedSlots int32  `json:"occupied_slots,omitempty"`
	UsedSlots     int32  `json:"used_slots,omitempty"`
	QueuedSlots   int32  `json:"queued_slots,omitempty"`
	OpenSlots     int32  `json:"open_slots,omitempty"`
}

Pool struct for Pool

type PoolApiService 

type PoolApiService service

PoolApiService PoolApi service

func (*PoolApiService) DeletePool 

func (a *PoolApiService) DeletePool(ctx _context.Context, poolName string) (*_nethttp.Response, error)

DeletePool Delete a pool

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolName The Pool name.

func (*PoolApiService) GetPool 

func (a *PoolApiService) GetPool(ctx _context.Context, poolName string) (Pool, *_nethttp.Response, error)

GetPool Get a pool

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolName The Pool name.

@return Pool

func (*PoolApiService) GetPools 

func (a *PoolApiService) GetPools(ctx _context.Context, localVarOptionals *GetPoolsOpts) (PoolCollection, *_nethttp.Response, error)

GetPools Get all pools

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetPoolsOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.

@return PoolCollection

func (*PoolApiService) PatchPool 

func (a *PoolApiService) PatchPool(ctx _context.Context, poolName string, pool Pool, localVarOptionals *PatchPoolOpts) (Pool, *_nethttp.Response, error)

PatchPool Update a pool

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param poolName The Pool name.
  • @param pool
  • @param optional nil or *PatchPoolOpts - Optional Parameters:
  • @param "UpdateMask" (optional.Interface of []string) - The fields to update on the connection (connection, pool etc). If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields.

@return Pool

func (*PoolApiService) PostPool 

func (a *PoolApiService) PostPool(ctx _context.Context, pool Pool) (Pool, *_nethttp.Response, error)

PostPool Create a pool

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param pool

@return Pool

type PoolCollection 

type PoolCollection struct {
	Pools []Pool `json:"pools,omitempty"`
}

PoolCollection struct for PoolCollection

type RelativeDelta 

type RelativeDelta struct {
	Type         string `json:"__type"`
	Years        int32  `json:"years,omitempty"`
	Months       int32  `json:"months,omitempty"`
	Days         int32  `json:"days,omitempty"`
	Leapdays     int32  `json:"leapdays,omitempty"`
	Hours        int32  `json:"hours,omitempty"`
	Minutes      int32  `json:"minutes,omitempty"`
	Seconds      int32  `json:"seconds,omitempty"`
	Microseconds int32  `json:"microseconds,omitempty"`
	Year         int32  `json:"year,omitempty"`
	Month        int32  `json:"month,omitempty"`
	Day          int32  `json:"day,omitempty"`
	Hour         int32  `json:"hour,omitempty"`
	Minute       int32  `json:"minute,omitempty"`
	Second       int32  `json:"second,omitempty"`
	Microsecond  int32  `json:"microsecond,omitempty"`
}

RelativeDelta struct for RelativeDelta

type ScheduleInterval 

type ScheduleInterval struct {
	Type         string `json:"__type"`
	Days         int32  `json:"days,omitempty"`
	Seconds      int32  `json:"seconds,omitempty"`
	Microsecond  int32  `json:"microsecond,omitempty"`
	Years        int32  `json:"years,omitempty"`
	Months       int32  `json:"months,omitempty"`
	Leapdays     int32  `json:"leapdays,omitempty"`
	Hours        int32  `json:"hours,omitempty"`
	Minutes      int32  `json:"minutes,omitempty"`
	Microseconds int32  `json:"microseconds,omitempty"`
	Year         int32  `json:"year,omitempty"`
	Month        int32  `json:"month,omitempty"`
	Day          int32  `json:"day,omitempty"`
	Hour         int32  `json:"hour,omitempty"`
	Minute       int32  `json:"minute,omitempty"`
	Second       int32  `json:"second,omitempty"`
	Value        string `json:"value,omitempty"`
}

ScheduleInterval struct for ScheduleInterval

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SlaMiss 

type SlaMiss struct {
	TaskId           string `json:"task_id,omitempty"`
	DagId            string `json:"dag_id,omitempty"`
	ExecutionDate    string `json:"execution_date,omitempty"`
	EmailSent        bool   `json:"email_sent,omitempty"`
	Timestamp        string `json:"timestamp,omitempty"`
	Description      string `json:"description,omitempty"`
	NotificationSent bool   `json:"notification_sent,omitempty"`
}

SlaMiss struct for SlaMiss

type SlaMissCollection 

type SlaMissCollection struct {
	SlaMisses []SlaMiss `json:"sla_misses,omitempty"`
}

SlaMissCollection struct for SlaMissCollection

type Tag 

type Tag struct {
	Name string `json:"name,omitempty"`
}

Tag struct for Tag

type Task 

type Task struct {
	ClassRef                ClassReference   `json:"class_ref,omitempty"`
	TaskId                  string           `json:"task_id,omitempty"`
	Owner                   string           `json:"owner,omitempty"`
	StartDate               time.Time        `json:"start_date,omitempty"`
	EndDate                 time.Time        `json:"end_date,omitempty"`
	TriggerRule             TriggerRule      `json:"trigger_rule,omitempty"`
	ExtraLinks              []TaskExtraLinks `json:"extra_links,omitempty"`
	DependsOnPast           bool             `json:"depends_on_past,omitempty"`
	WaitForDownstream       bool             `json:"wait_for_downstream,omitempty"`
	Retries                 float32          `json:"retries,omitempty"`
	Queue                   string           `json:"queue,omitempty"`
	Pool                    string           `json:"pool,omitempty"`
	PoolSlots               float32          `json:"pool_slots,omitempty"`
	ExecutionTimeout        TimeDelta        `json:"execution_timeout,omitempty"`
	RetryDelay              TimeDelta        `json:"retry_delay,omitempty"`
	RetryExponentialBackoff bool             `json:"retry_exponential_backoff,omitempty"`
	PriorityWeight          float32          `json:"priority_weight,omitempty"`
	WeightRule              WeightRule       `json:"weight_rule,omitempty"`
	UiColor                 string           `json:"ui_color,omitempty"`
	UiFgcolor               string           `json:"ui_fgcolor,omitempty"`
	TemplateFields          []string         `json:"template_fields,omitempty"`
	SubDag                  Dag              `json:"sub_dag,omitempty"`
	DownstreamTaskIds       []string         `json:"downstream_task_ids,omitempty"`
}

Task struct for Task

type TaskCollection 

type TaskCollection struct {
	Tasks []Task `json:"tasks,omitempty"`
}

TaskCollection struct for TaskCollection 

type TaskExtraLinks struct {
	ClassRef ClassReference `json:"class_ref,omitempty"`
}

TaskExtraLinks struct for TaskExtraLinks

type TaskFail 

type TaskFail struct {
	TaskId        string `json:"task_id,omitempty"`
	DagId         string `json:"dag_id,omitempty"`
	ExecutionDate string `json:"execution_date,omitempty"`
	StartDate     string `json:"start_date,omitempty"`
	EndDate       string `json:"end_date,omitempty"`
	Duration      int32  `json:"duration,omitempty"`
}

TaskFail struct for TaskFail

type TaskInstance 

type TaskInstance struct {
	TaskId         string    `json:"task_id,omitempty"`
	DagId          string    `json:"dag_id,omitempty"`
	ExecutionDate  string    `json:"execution_date,omitempty"`
	StartDate      string    `json:"start_date,omitempty"`
	EndDate        string    `json:"end_date,omitempty"`
	Duration       float32   `json:"duration,omitempty"`
	State          TaskState `json:"state,omitempty"`
	TryNumber      int32     `json:"try_number,omitempty"`
	MaxTries       int32     `json:"max_tries,omitempty"`
	Hostname       string    `json:"hostname,omitempty"`
	Unixname       string    `json:"unixname,omitempty"`
	Pool           string    `json:"pool,omitempty"`
	PoolSlots      int32     `json:"pool_slots,omitempty"`
	Queue          string    `json:"queue,omitempty"`
	PriorityWeight int32     `json:"priority_weight,omitempty"`
	Operator       string    `json:"operator,omitempty"`
	QueuedWhen     string    `json:"queued_when,omitempty"`
	Pid            int32     `json:"pid,omitempty"`
	ExecutorConfig string    `json:"executor_config,omitempty"`
	SlaMiss        SlaMiss   `json:"sla_miss,omitempty"`
}

TaskInstance struct for TaskInstance

type TaskInstanceApiService 

type TaskInstanceApiService service

TaskInstanceApiService TaskInstanceApi service 

func (a *TaskInstanceApiService) GetExtraLinks(ctx _context.Context, dagId string, dagRunId string, taskId string) (ExtraLinkCollection, *_nethttp.Response, error)

GetExtraLinks Get extra links for task instance

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param taskId The Task ID.

@return ExtraLinkCollection

func (*TaskInstanceApiService) GetLog 

func (a *TaskInstanceApiService) GetLog(ctx _context.Context, dagId string, dagRunId string, taskId string, taskTryNumber int32, localVarOptionals *GetLogOpts) (InlineResponse200, *_nethttp.Response, error)

GetLog Get logs for a task instance Get logs for a specific task instance and its try number

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param taskId The Task ID.
  • @param taskTryNumber The Task Try Number.
  • @param optional nil or *GetLogOpts - Optional Parameters:
  • @param "FullContent" (optional.Bool) - A full content will be returned. By default, only the first fragment will be returned.
  • @param "Token" (optional.String) - A token that allows you to continue fetching logs. If passed, it will specify the location from which the download should be continued.

@return InlineResponse200

func (*TaskInstanceApiService) GetTaskInstance 

func (a *TaskInstanceApiService) GetTaskInstance(ctx _context.Context, dagId string, dagRunId string, taskId string) (TaskInstance, *_nethttp.Response, error)

GetTaskInstance Get a task instance

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param taskId The Task ID.

@return TaskInstance

func (*TaskInstanceApiService) GetTaskInstances 

func (a *TaskInstanceApiService) GetTaskInstances(ctx _context.Context, dagId string, dagRunId string, localVarOptionals *GetTaskInstancesOpts) (TaskInstanceCollection, *_nethttp.Response, error)

GetTaskInstances Get a list of task instance of DAG. This endpoint allows specifying `~` as the dag_id, dag_run_id to retrieve DAG Runs for all DAGs and DAG Runs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param optional nil or *GetTaskInstancesOpts - Optional Parameters:
  • @param "ExecutionDateGte" (optional.Time) - Returns objects greater or equal to the specified date. This can be combined with execution_date_lte parameter to receive only the selected period.
  • @param "ExecutionDateLte" (optional.Time) - Returns objects less than or equal to the specified date. This can be combined with execution_date_gte parameter to receive only the selected period.
  • @param "StartDateGte" (optional.Time) - Returns objects greater or equal the specified date. This can be combined with startd_ate_lte parameter to receive only the selected period.
  • @param "StartDateLte" (optional.Time) - Returns objects less or equal the specified date. This can be combined with start_date_gte parameter to receive only the selected period.
  • @param "EndDateGte" (optional.Time) - Returns objects greater or equal the specified date. This can be combined with start_date_lte parameter to receive only the selected period.
  • @param "EndDateLte" (optional.Time) - Returns objects less than or equal to the specified date. This can be combined with start_date_gte parameter to receive only the selected period.
  • @param "DurationGte" (optional.Float32) - Returns objects greater than or equal to the specified values. This can be combined with duration_lte parameter to receive only the selected period.
  • @param "DurationLte" (optional.Float32) - Returns objects less than or equal to the specified values. This can be combined with duration_gte parameter to receive only the selected range.
  • @param "State" (optional.Interface of []string) - The value can be repeated to retrieve multiple matching values (OR condition).
  • @param "Pool" (optional.Interface of []string) - The value can be repeated to retrieve multiple matching values (OR condition).
  • @param "Queue" (optional.Interface of []string) - The value can be repeated to retrieve multiple matching values (OR condition).
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.

@return TaskInstanceCollection

func (*TaskInstanceApiService) GetTaskInstancesBatch 

func (a *TaskInstanceApiService) GetTaskInstancesBatch(ctx _context.Context, listTaskInstanceForm ListTaskInstanceForm) (TaskInstanceCollection, *_nethttp.Response, error)

GetTaskInstancesBatch Get list of task instances from all DAGs and DAG Runs. This endpoint is a POST to allow filtering across a large number of DAG IDs, where as a GET it would run in to maximum HTTP request URL lengthlimits

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param listTaskInstanceForm

@return TaskInstanceCollection

type TaskInstanceCollection 

type TaskInstanceCollection struct {
	TaskInstances []TaskInstance `json:"task_instances,omitempty"`
}

TaskInstanceCollection struct for TaskInstanceCollection

type TaskInstanceReference 

type TaskInstanceReference struct {
	TaskId        string `json:"task_id,omitempty"`
	DagId         string `json:"dag_id,omitempty"`
	ExecutionDate string `json:"execution_date,omitempty"`
	DagRunId      string `json:"dag_run_id,omitempty"`
}

TaskInstanceReference struct for TaskInstanceReference

type TaskInstanceReferenceCollection 

type TaskInstanceReferenceCollection struct {
	TaskInstances []TaskInstanceReference `json:"task_instances,omitempty"`
}

TaskInstanceReferenceCollection struct for TaskInstanceReferenceCollection

type TaskState 

type TaskState string

TaskState the model 'TaskState' 

const (
	TASKSTATE_SUCCCESS          TaskState = "succcess"
	TASKSTATE_RUNNING           TaskState = "running"
	TASKSTATE_FAILED            TaskState = "failed"
	TASKSTATE_UPSTREAM_FAILED   TaskState = "upstream_failed"
	TASKSTATE_SKIPPED           TaskState = "skipped"
	TASKSTATE_UP_FOR_RETRY      TaskState = "up_for_retry"
	TASKSTATE_UP_FOR_RESCHEDULE TaskState = "up_for_reschedule"
	TASKSTATE_QUEUED            TaskState = "queued"
	TASKSTATE_NONE              TaskState = "none"
	TASKSTATE_SCHEDULED         TaskState = "scheduled"
)

List of TaskState

type TimeDelta 

type TimeDelta struct {
	Type        string `json:"__type"`
	Days        int32  `json:"days,omitempty"`
	Seconds     int32  `json:"seconds,omitempty"`
	Microsecond int32  `json:"microsecond,omitempty"`
}

TimeDelta struct for TimeDelta

type TriggerRule 

type TriggerRule string

TriggerRule the model 'TriggerRule' 

const (
	TRIGGERRULE_ALL_SUCCESS            TriggerRule = "all_success"
	TRIGGERRULE_ALL_FAILED             TriggerRule = "all_failed"
	TRIGGERRULE_ALL_DONE               TriggerRule = "all_done"
	TRIGGERRULE_ONE_SUCCESS            TriggerRule = "one_success"
	TRIGGERRULE_ONE_FAILED             TriggerRule = "one_failed"
	TRIGGERRULE_NONE_FAILED            TriggerRule = "none_failed"
	TRIGGERRULE_NONE_SKIPPED           TriggerRule = "none_skipped"
	TRIGGERRULE_NONE_FAILED_OR_SKIPPED TriggerRule = "none_failed_or_skipped"
	TRIGGERRULE_DUMMY                  TriggerRule = "dummy"
)

List of TriggerRule

type Variable 

type Variable struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

Variable struct for Variable

type VariableAllOf 

type VariableAllOf struct {
	Value string `json:"value,omitempty"`
}

VariableAllOf struct for VariableAllOf

type VariableApiService 

type VariableApiService service

VariableApiService VariableApi service

func (*VariableApiService) DeleteVariable 

func (a *VariableApiService) DeleteVariable(ctx _context.Context, variableKey string) (*_nethttp.Response, error)

DeleteVariable Delete variable

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param variableKey The Variable Key.

func (*VariableApiService) GetVariable 

func (a *VariableApiService) GetVariable(ctx _context.Context, variableKey string) (Variable, *_nethttp.Response, error)

GetVariable Get a variable by key

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param variableKey The Variable Key.

@return Variable

func (*VariableApiService) GetVariables 

func (a *VariableApiService) GetVariables(ctx _context.Context, localVarOptionals *GetVariablesOpts) (VariableCollection, *_nethttp.Response, error)

GetVariables Get all variables The collection does not contain data. To get data, you must get a single entity.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetVariablesOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.

@return VariableCollection

func (*VariableApiService) PatchVariable 

func (a *VariableApiService) PatchVariable(ctx _context.Context, variableKey string, variable Variable, localVarOptionals *PatchVariableOpts) (Variable, *_nethttp.Response, error)

PatchVariable Update a variable by key

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param variableKey The Variable Key.
  • @param variable
  • @param optional nil or *PatchVariableOpts - Optional Parameters:
  • @param "UpdateMask" (optional.Interface of []string) - The fields to update on the connection (connection, pool etc). If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields.

@return Variable

func (*VariableApiService) PostVariables 

func (a *VariableApiService) PostVariables(ctx _context.Context, variable Variable) (Variable, *_nethttp.Response, error)

PostVariables Create a variable

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param variable

@return Variable

type VariableCollection 

type VariableCollection struct {
	Variables []VariableCollectionItem `json:"variables,omitempty"`
}

VariableCollection struct for VariableCollection

type VariableCollectionItem 

type VariableCollectionItem struct {
	Key string `json:"key,omitempty"`
}

VariableCollectionItem struct for VariableCollectionItem

type VersionInfo 

type VersionInfo struct {
	// The version of Airflow
	Version string `json:"version,omitempty"`
	// The git version (including git commit hash)
	GitVersion *string `json:"git_version,omitempty"`
}

VersionInfo Version information.

type WeightRule 

type WeightRule string

WeightRule the model 'WeightRule' 

const (
	WEIGHTRULE_DOWNSTREAM WeightRule = "downstream"
	WEIGHTRULE_UPSTREAM   WeightRule = "upstream"
	WEIGHTRULE_ABSOLUTE   WeightRule = "absolute"
)

List of WeightRule

type XCom 

type XCom struct {
	Key           string `json:"key,omitempty"`
	Timestamp     string `json:"timestamp,omitempty"`
	ExecutionDate string `json:"execution_date,omitempty"`
	TaskId        string `json:"task_id,omitempty"`
	DagId         string `json:"dag_id,omitempty"`
	Value         string `json:"value,omitempty"`
}

XCom struct for XCom

type XComApiService 

type XComApiService service

XComApiService XComApi service

func (*XComApiService) DeleteXcomEntry 

func (a *XComApiService) DeleteXcomEntry(ctx _context.Context, dagId string, dagRunId string, taskId string, xcomKey string) (*_nethttp.Response, error)

DeleteXcomEntry Delete an XCom entry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param taskId The Task ID.
  • @param xcomKey The XCom Key.

func (*XComApiService) GetXcomEntries 

func (a *XComApiService) GetXcomEntries(ctx _context.Context, dagId string, dagRunId string, taskId string, localVarOptionals *GetXcomEntriesOpts) (XComCollection, *_nethttp.Response, error)

GetXcomEntries Get all XCom entries This endpoint allows specifying `~` as the dag_id, dag_run_id, task_id to retrieve XCOM entries for for all DAGs, DAG Runs and task instances.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param taskId The Task ID.
  • @param optional nil or *GetXcomEntriesOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - The numbers of items to return.
  • @param "Offset" (optional.Int32) - The number of items to skip before starting to collect the result set.

@return XComCollection

func (*XComApiService) GetXcomEntry 

func (a *XComApiService) GetXcomEntry(ctx _context.Context, dagId string, dagRunId string, taskId string, xcomKey string) (XCom, *_nethttp.Response, error)

GetXcomEntry Get an XCom entry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param taskId The Task ID.
  • @param xcomKey The XCom Key.

@return XCom

func (*XComApiService) PatchXcomEntry 

func (a *XComApiService) PatchXcomEntry(ctx _context.Context, dagId string, dagRunId string, taskId string, xcomKey string, xCom XCom, localVarOptionals *PatchXcomEntryOpts) (XCom, *_nethttp.Response, error)

PatchXcomEntry Update an XCom entry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param taskId The Task ID.
  • @param xcomKey The XCom Key.
  • @param xCom
  • @param optional nil or *PatchXcomEntryOpts - Optional Parameters:
  • @param "UpdateMask" (optional.Interface of []string) - The fields to update on the connection (connection, pool etc). If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields.

@return XCom

func (*XComApiService) PostXcomEntries 

func (a *XComApiService) PostXcomEntries(ctx _context.Context, dagId string, dagRunId string, taskId string, xCom XCom) (XCom, *_nethttp.Response, error)

PostXcomEntries Create an XCom entry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dagId The DAG ID.
  • @param dagRunId The DAG Run ID.
  • @param taskId The Task ID.
  • @param xCom

@return XCom

type XComCollection 

type XComCollection struct {
	XcomEntries []XComCollectionItem `json:"xcom_entries,omitempty"`
}

XComCollection struct for XComCollection

type XComCollectionItem 

type XComCollectionItem struct {
	Key           string `json:"key,omitempty"`
	Timestamp     string `json:"timestamp,omitempty"`
	ExecutionDate string `json:"execution_date,omitempty"`
	TaskId        string `json:"task_id,omitempty"`
	DagId         string `json:"dag_id,omitempty"`
}

XComCollectionItem struct for XComCollectionItem

Source Files

View all Source files

Directories

Path Synopsis
airflow module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.