Documentation
¶
Overview ¶
Package genmodels holds the Go data models for the coordinator-protocol IPC messages (msgpack-over-socket) exchanged between the Airflow supervisor and a Go SDK bundle in coordinator mode.
These files are generated from the supervisor wire-schema snapshot owned by the Python Task SDK (task-sdk/src/airflow/sdk/execution_time/schema/schema.json): models.gen.go holds the struct types, discriminators.gen.go the Type<Name> constants and EnsureType, defaults.gen.go the DecodeMsgpack methods that seed non-zero schema defaults. Don't edit them by hand; change the Pydantic models, let the generate-supervisor-schemas-snapshot prek hook refresh the snapshot, then re-run `just generate-models` (go generate).
go generate runs go-jsonschema, then the local gen tool, which strips go-jsonschema's dead anyOf-branch typedefs, widens concrete int/float/bool fields whose schema default their Go zero value does not satisfy to pointers (so an unset value is omitted on the wire and the supervisor reapplies the default, while an explicit 0/false still encodes), and emits discriminators.gen.go and defaults.gen.go.
Index ¶
- Constants
- func EnsureType(m any) any
- type AssetAliasReferenceAssetEventDagRun
- type AssetEventDagRunReference
- type AssetEventResponse
- type AssetEventsResult
- type AssetProfile
- type AssetReferenceAssetEventDagRun
- type AssetResponse
- type AssetResult
- type AssetStateStoreResult
- type AssetsByAliasResult
- type AssignedUsers
- type AwaitInputTask
- type BundleInfo
- type ClearAssetStateStoreByName
- type ClearAssetStateStoreByURI
- type ClearTaskStateStore
- type Conf
- type ConnectionResponse
- type ConnectionResult
- type ContextCarrier
- type CreateHITLDetailPayload
- type DRCount
- type DagCallbackRequest
- type DagFileParseRequest
- type DagFileParsingResult
- type DagResult
- type DagRun
- type DagRunAssetReference
- type DagRunContext
- type DagRunResult
- type DagRunState
- type DagRunStateResult
- type DagRunType
- type Data
- type Defaults
- type DeferTask
- type DeleteAssetStateStoreByName
- type DeleteAssetStateStoreByURI
- type DeleteTaskStateStore
- type DeleteVariable
- type DeleteXCom
- type Detail
- type EmailRequest
- type EmailRequestEmailType
- type ErrorResponse
- type ErrorType
- type Extra
- type GetAssetByName
- type GetAssetByURI
- type GetAssetEventByAsset
- type GetAssetEventByAssetAlias
- type GetAssetStateStoreByName
- type GetAssetStateStoreByURI
- type GetAssetsByAlias
- type GetConnection
- type GetDRCount
- type GetDag
- type GetDagRun
- type GetDagRunState
- type GetHITLDetailResponse
- type GetPrevSuccessfulDagRun
- type GetPreviousDagRun
- type GetPreviousTI
- type GetTICount
- type GetTaskBreadcrumbs
- type GetTaskRescheduleStartDate
- type GetTaskStateStore
- type GetTaskStates
- type GetVariable
- type GetVariableKeys
- type GetXCom
- type GetXComCount
- type GetXComSequenceItem
- type GetXComSequenceSlice
- type HITLDetailRequestResult
- type HITLUser
- type ImportErrors
- type InactiveAssets
- type InactiveAssetsResult
- type JsonValue
- type LazyDeserializedDAG
- type LogicalDates
- type MaskSecret
- type NextKwargs
- type OKResponse
- type OutletEvents
- type Params
- type ParamsInput
- type PrevSuccessfulDagRunResult
- type PreviousDagRunResult
- type PreviousTIResponse
- type PreviousTIResult
- type PutVariable
- type RenderedFields
- type RescheduleTask
- type ResendLoggingFD
- type RetryTask
- type RunIds
- type SentFDs
- type SetAssetStateStoreByName
- type SetAssetStateStoreByURI
- type SetRenderedFields
- type SetRenderedMapIndex
- type SetTaskStateStore
- type SetXCom
- type SkipDownstreamTasks
- type StartupDetails
- type States
- type SucceedTask
- type TICount
- type TIRunContext
- type TaskBreadcrumbsResult
- type TaskBreadcrumbsResultBreadcrumbsElem
- type TaskCallbackRequest
- type TaskIds
- type TaskInstance
- type TaskInstanceState
- type TaskOutlets
- type TaskRescheduleStartDate
- type TaskState
- type TaskStateState
- type TaskStateStoreResult
- type TaskStates
- type TaskStatesResult
- type TriggerDagRun
- type TriggerKwargs
- type UpdateHITLDetail
- type ValidateInletsAndOutlets
- type VariableKeysResult
- type VariableResponse
- type VariableResult
- type VersionData
- type Warnings
- type XComCountResponse
- type XComResult
- type XComSequenceIndexResult
- type XComSequenceSliceResult
Constants ¶
const ( TypeAssetEventsResult = "AssetEventsResult" TypeAssetResult = "AssetResult" TypeAssetStateStoreResult = "AssetStateStoreResult" TypeAssetsByAliasResult = "AssetsByAliasResult" TypeAwaitInputTask = "AwaitInputTask" TypeClearAssetStateStoreByName = "ClearAssetStateStoreByName" TypeClearAssetStateStoreByURI = "ClearAssetStateStoreByUri" TypeClearTaskStateStore = "ClearTaskStateStore" TypeConnectionResult = "ConnectionResult" TypeCreateHITLDetailPayload = "CreateHITLDetailPayload" TypeDRCount = "DRCount" TypeDagCallbackRequest = "DagCallbackRequest" TypeDagFileParseRequest = "DagFileParseRequest" TypeDagFileParsingResult = "DagFileParsingResult" TypeDagResult = "DagResult" TypeDagRunResult = "DagRunResult" TypeDagRunStateResult = "DagRunStateResult" TypeDeferTask = "DeferTask" TypeDeleteAssetStateStoreByName = "DeleteAssetStateStoreByName" TypeDeleteAssetStateStoreByURI = "DeleteAssetStateStoreByUri" TypeDeleteTaskStateStore = "DeleteTaskStateStore" TypeDeleteVariable = "DeleteVariable" TypeDeleteXCom = "DeleteXCom" TypeEmailRequest = "EmailRequest" TypeErrorResponse = "ErrorResponse" TypeGetAssetByName = "GetAssetByName" TypeGetAssetByURI = "GetAssetByUri" TypeGetAssetEventByAsset = "GetAssetEventByAsset" TypeGetAssetEventByAssetAlias = "GetAssetEventByAssetAlias" TypeGetAssetStateStoreByName = "GetAssetStateStoreByName" TypeGetAssetStateStoreByURI = "GetAssetStateStoreByUri" TypeGetAssetsByAlias = "GetAssetsByAlias" TypeGetConnection = "GetConnection" TypeGetDRCount = "GetDRCount" TypeGetDag = "GetDag" TypeGetDagRun = "GetDagRun" TypeGetDagRunState = "GetDagRunState" TypeGetHITLDetailResponse = "GetHITLDetailResponse" TypeGetPrevSuccessfulDagRun = "GetPrevSuccessfulDagRun" TypeGetPreviousDagRun = "GetPreviousDagRun" TypeGetPreviousTI = "GetPreviousTI" TypeGetTICount = "GetTICount" TypeGetTaskBreadcrumbs = "GetTaskBreadcrumbs" TypeGetTaskRescheduleStartDate = "GetTaskRescheduleStartDate" TypeGetTaskStateStore = "GetTaskStateStore" TypeGetTaskStates = "GetTaskStates" TypeGetVariable = "GetVariable" TypeGetVariableKeys = "GetVariableKeys" TypeGetXCom = "GetXCom" TypeGetXComCount = "GetXComCount" TypeGetXComSequenceItem = "GetXComSequenceItem" TypeGetXComSequenceSlice = "GetXComSequenceSlice" TypeHITLDetailRequestResult = "HITLDetailRequestResult" TypeInactiveAssetsResult = "InactiveAssetsResult" TypeMaskSecret = "MaskSecret" TypeOKResponse = "OKResponse" TypePrevSuccessfulDagRunResult = "PrevSuccessfulDagRunResult" TypePreviousDagRunResult = "PreviousDagRunResult" TypePreviousTIResult = "PreviousTIResult" TypePutVariable = "PutVariable" TypeRescheduleTask = "RescheduleTask" TypeResendLoggingFD = "ResendLoggingFD" TypeRetryTask = "RetryTask" TypeSentFDs = "SentFDs" TypeSetAssetStateStoreByName = "SetAssetStateStoreByName" TypeSetAssetStateStoreByURI = "SetAssetStateStoreByUri" TypeSetRenderedFields = "SetRenderedFields" TypeSetRenderedMapIndex = "SetRenderedMapIndex" TypeSetTaskStateStore = "SetTaskStateStore" TypeSetXCom = "SetXCom" TypeSkipDownstreamTasks = "SkipDownstreamTasks" TypeStartupDetails = "StartupDetails" TypeSucceedTask = "SucceedTask" TypeTICount = "TICount" TypeTaskBreadcrumbsResult = "TaskBreadcrumbsResult" TypeTaskCallbackRequest = "TaskCallbackRequest" TypeTaskRescheduleStartDate = "TaskRescheduleStartDate" TypeTaskState = "TaskState" TypeTaskStateStoreResult = "TaskStateStoreResult" TypeTaskStatesResult = "TaskStatesResult" TypeTriggerDagRun = "TriggerDagRun" TypeUpdateHITLDetail = "UpdateHITLDetail" TypeValidateInletsAndOutlets = "ValidateInletsAndOutlets" TypeVariableKeysResult = "VariableKeysResult" TypeVariableResult = "VariableResult" TypeXComCountResponse = "XComCountResponse" TypeXComResult = "XComResult" TypeXComSequenceIndexResult = "XComSequenceIndexResult" TypeXComSequenceSliceResult = "XComSequenceSliceResult" )
Message-type discriminator constants, generated from each body's "type" const in the supervisor wire-schema: the single source of truth for the "type" field's value, so callers never hand-write strings that could drift.
Variables ¶
This section is empty.
Functions ¶
func EnsureType ¶
EnsureType returns m with its "type" discriminator set to the constant bound to its Go type, dereferencing a pointer body first; non-body values pass through. The frame encoder runs every outbound body through it, so the binding lives only here and call sites can't pair the wrong constant with a struct.
Types ¶
type AssetAliasReferenceAssetEventDagRun ¶
type AssetAliasReferenceAssetEventDagRun struct {
// Name corresponds to the JSON schema field "name".
Name string `msgpack:"name"`
}
Schema for AssetAliasModel used in AssetEventDagRunReference.
type AssetEventDagRunReference ¶
type AssetEventDagRunReference struct {
// Asset corresponds to the JSON schema field "asset".
Asset AssetReferenceAssetEventDagRun `msgpack:"asset"`
// Extra corresponds to the JSON schema field "extra".
Extra Extra `msgpack:"extra"`
// PartitionKey corresponds to the JSON schema field "partition_key".
PartitionKey interface{} `msgpack:"partition_key,omitempty"`
// SourceAliases corresponds to the JSON schema field "source_aliases".
SourceAliases []AssetAliasReferenceAssetEventDagRun `msgpack:"source_aliases"`
// SourceDagID corresponds to the JSON schema field "source_dag_id".
SourceDagID interface{} `msgpack:"source_dag_id"`
// SourceMapIndex corresponds to the JSON schema field "source_map_index".
SourceMapIndex interface{} `msgpack:"source_map_index"`
// SourceRunID corresponds to the JSON schema field "source_run_id".
SourceRunID interface{} `msgpack:"source_run_id"`
// SourceTaskID corresponds to the JSON schema field "source_task_id".
SourceTaskID interface{} `msgpack:"source_task_id"`
// Timestamp corresponds to the JSON schema field "timestamp".
Timestamp time.Time `msgpack:"timestamp"`
}
Schema for AssetEvent model used in DagRun.
type AssetEventResponse ¶
type AssetEventResponse struct {
// Asset corresponds to the JSON schema field "asset".
Asset AssetResponse `msgpack:"asset"`
// CreatedDagruns corresponds to the JSON schema field "created_dagruns".
CreatedDagruns []DagRunAssetReference `msgpack:"created_dagruns"`
// Extra corresponds to the JSON schema field "extra".
Extra *Extra `msgpack:"extra,omitempty"`
// ID corresponds to the JSON schema field "id".
ID int `msgpack:"id"`
// PartitionKey corresponds to the JSON schema field "partition_key".
PartitionKey interface{} `msgpack:"partition_key,omitempty"`
// SourceDagID corresponds to the JSON schema field "source_dag_id".
SourceDagID interface{} `msgpack:"source_dag_id,omitempty"`
// SourceMapIndex corresponds to the JSON schema field "source_map_index".
SourceMapIndex interface{} `msgpack:"source_map_index,omitempty"`
// SourceRunID corresponds to the JSON schema field "source_run_id".
SourceRunID interface{} `msgpack:"source_run_id,omitempty"`
// SourceTaskID corresponds to the JSON schema field "source_task_id".
SourceTaskID interface{} `msgpack:"source_task_id,omitempty"`
// Timestamp corresponds to the JSON schema field "timestamp".
Timestamp time.Time `msgpack:"timestamp"`
}
Asset event schema with fields that are needed for Runtime.
type AssetEventsResult ¶
type AssetEventsResult struct {
// AssetEvents corresponds to the JSON schema field "asset_events".
AssetEvents []AssetEventResponse `msgpack:"asset_events"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Response to GetAssetEvent request.
type AssetProfile ¶
type AssetProfile struct {
// Name corresponds to the JSON schema field "name".
Name interface{} `msgpack:"name,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type"`
// URI corresponds to the JSON schema field "uri".
URI interface{} `msgpack:"uri,omitempty"`
}
Profile of an asset-like object.
Asset will have name, uri defined, with type set to 'Asset'. AssetNameRef will have name defined, type set to 'AssetNameRef'. AssetUriRef will have uri defined, type set to 'AssetUriRef'. AssetAlias will have name defined, type set to 'AssetAlias'.
Note that 'type' here is distinct from 'asset_type' the user declares on an Asset (or subclass). This field is for distinguishing between different asset-related types (Asset, AssetRef, or AssetAlias).
type AssetReferenceAssetEventDagRun ¶
type AssetReferenceAssetEventDagRun struct {
// Extra corresponds to the JSON schema field "extra".
Extra Extra `msgpack:"extra"`
// Name corresponds to the JSON schema field "name".
Name string `msgpack:"name"`
// URI corresponds to the JSON schema field "uri".
URI string `msgpack:"uri"`
}
Schema for AssetModel used in AssetEventDagRunReference.
type AssetResponse ¶
type AssetResponse struct {
// Extra corresponds to the JSON schema field "extra".
Extra *Extra `msgpack:"extra,omitempty"`
// Group corresponds to the JSON schema field "group".
Group string `msgpack:"group"`
// Name corresponds to the JSON schema field "name".
Name string `msgpack:"name"`
// URI corresponds to the JSON schema field "uri".
URI string `msgpack:"uri"`
}
Asset schema for responses with fields that are needed for Runtime.
type AssetResult ¶
type AssetResult struct {
// Extra corresponds to the JSON schema field "extra".
Extra *Extra `msgpack:"extra,omitempty"`
// Group corresponds to the JSON schema field "group".
Group string `msgpack:"group"`
// Name corresponds to the JSON schema field "name".
Name string `msgpack:"name"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// URI corresponds to the JSON schema field "uri".
URI string `msgpack:"uri"`
}
Response to ReadXCom request.
type AssetStateStoreResult ¶
type AssetStateStoreResult struct {
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Value corresponds to the JSON schema field "value".
Value JsonValue `msgpack:"value"`
}
Response to GetAssetStateStore; wraps the generated API response for supervisor to worker comms.
type AssetsByAliasResult ¶
type AssetsByAliasResult struct {
// Assets corresponds to the JSON schema field "assets".
Assets []AssetResult `msgpack:"assets"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Response to GetAssetsByAlias; list of concrete assets resolved from an alias.
type AssignedUsers ¶
type AssignedUsers []HITLUser
type AwaitInputTask ¶
type AwaitInputTask struct {
// NextKwargs corresponds to the JSON schema field "next_kwargs".
NextKwargs *NextKwargs `msgpack:"next_kwargs,omitempty"`
// NextMethod corresponds to the JSON schema field "next_method".
NextMethod string `msgpack:"next_method"`
// RenderedMapIndex corresponds to the JSON schema field "rendered_map_index".
RenderedMapIndex interface{} `msgpack:"rendered_map_index,omitempty"`
// State corresponds to the JSON schema field "state".
State interface{} `msgpack:"state,omitempty"`
// Timeout corresponds to the JSON schema field "timeout".
Timeout interface{} `msgpack:"timeout,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Park a task instance awaiting human input (Human-in-the-loop), without a trigger.
func (*AwaitInputTask) DecodeMsgpack ¶
func (m *AwaitInputTask) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies AwaitInputTask's schema defaults that msgpack would otherwise skip.
type BundleInfo ¶
type BundleInfo struct {
// Name corresponds to the JSON schema field "name".
Name string `msgpack:"name"`
// Version corresponds to the JSON schema field "version".
Version interface{} `msgpack:"version,omitempty"`
// VersionData corresponds to the JSON schema field "version_data".
VersionData *VersionData `msgpack:"version_data,omitempty"`
}
Schema for telling task which bundle to run with.
type ClearTaskStateStore ¶
type ConnectionResponse ¶
type ConnectionResponse struct {
// ConnID corresponds to the JSON schema field "conn_id".
ConnID string `msgpack:"conn_id"`
// ConnType corresponds to the JSON schema field "conn_type".
ConnType string `msgpack:"conn_type"`
// Extra corresponds to the JSON schema field "extra".
Extra interface{} `msgpack:"extra"`
// Host corresponds to the JSON schema field "host".
Host interface{} `msgpack:"host"`
// Login corresponds to the JSON schema field "login".
Login interface{} `msgpack:"login"`
// Password corresponds to the JSON schema field "password".
Password interface{} `msgpack:"password"`
// Port corresponds to the JSON schema field "port".
Port interface{} `msgpack:"port"`
// Schema corresponds to the JSON schema field "schema".
Schema interface{} `msgpack:"schema"`
}
Connection schema for responses with fields that are needed for Runtime.
type ConnectionResult ¶
type ConnectionResult struct {
// ConnID corresponds to the JSON schema field "conn_id".
ConnID string `msgpack:"conn_id"`
// ConnType corresponds to the JSON schema field "conn_type".
ConnType string `msgpack:"conn_type"`
// Extra corresponds to the JSON schema field "extra".
Extra interface{} `msgpack:"extra,omitempty"`
// Host corresponds to the JSON schema field "host".
Host interface{} `msgpack:"host,omitempty"`
// Login corresponds to the JSON schema field "login".
Login interface{} `msgpack:"login,omitempty"`
// Password corresponds to the JSON schema field "password".
Password interface{} `msgpack:"password,omitempty"`
// Port corresponds to the JSON schema field "port".
Port interface{} `msgpack:"port,omitempty"`
// Schema corresponds to the JSON schema field "schema".
Schema interface{} `msgpack:"schema,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type ContextCarrier ¶
type ContextCarrier map[string]interface{}
type CreateHITLDetailPayload ¶
type CreateHITLDetailPayload struct {
// AssignedUsers corresponds to the JSON schema field "assigned_users".
AssignedUsers *AssignedUsers `msgpack:"assigned_users,omitempty"`
// Body corresponds to the JSON schema field "body".
Body interface{} `msgpack:"body,omitempty"`
// Defaults corresponds to the JSON schema field "defaults".
Defaults *Defaults `msgpack:"defaults,omitempty"`
// Multiple corresponds to the JSON schema field "multiple".
Multiple interface{} `msgpack:"multiple,omitempty"`
// Options corresponds to the JSON schema field "options".
Options []string `msgpack:"options"`
// Params corresponds to the JSON schema field "params".
Params *Params `msgpack:"params,omitempty"`
// Subject corresponds to the JSON schema field "subject".
Subject string `msgpack:"subject"`
// TIID corresponds to the JSON schema field "ti_id".
TIID string `msgpack:"ti_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Add the input request part of a Human-in-the-loop response.
func (*CreateHITLDetailPayload) DecodeMsgpack ¶
func (m *CreateHITLDetailPayload) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies CreateHITLDetailPayload's schema defaults that msgpack would otherwise skip.
type DRCount ¶
type DRCount struct {
// Count corresponds to the JSON schema field "count".
Count int `msgpack:"count"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Response containing count of Dag Runs matching certain filters.
type DagCallbackRequest ¶
type DagCallbackRequest struct {
// BundleName corresponds to the JSON schema field "bundle_name".
BundleName string `msgpack:"bundle_name"`
// BundleVersion corresponds to the JSON schema field "bundle_version".
BundleVersion interface{} `msgpack:"bundle_version"`
// ContextFromServer corresponds to the JSON schema field "context_from_server".
ContextFromServer *DagRunContext `msgpack:"context_from_server,omitempty"`
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// Filepath corresponds to the JSON schema field "filepath".
Filepath string `msgpack:"filepath"`
// IsFailureCallback corresponds to the JSON schema field "is_failure_callback".
IsFailureCallback interface{} `msgpack:"is_failure_callback,omitempty"`
// Msg corresponds to the JSON schema field "msg".
Msg interface{} `msgpack:"msg,omitempty"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
A Class with information about the success/failure DAG callback to be executed.
func (*DagCallbackRequest) DecodeMsgpack ¶
func (m *DagCallbackRequest) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies DagCallbackRequest's schema defaults that msgpack would otherwise skip.
type DagFileParseRequest ¶
type DagFileParseRequest struct {
// BundleName corresponds to the JSON schema field "bundle_name".
BundleName string `msgpack:"bundle_name"`
// BundlePath corresponds to the JSON schema field "bundle_path".
BundlePath string `msgpack:"bundle_path"`
// CallbackRequests corresponds to the JSON schema field "callback_requests".
CallbackRequests []interface{} `msgpack:"callback_requests,omitempty"`
// File corresponds to the JSON schema field "file".
File string `msgpack:"file"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Request for DAG File Parsing.
This is the request that the manager will send to the DAG parser with the dag file and any other necessary metadata.
type DagFileParsingResult ¶
type DagFileParsingResult struct {
// Fileloc corresponds to the JSON schema field "fileloc".
Fileloc string `msgpack:"fileloc"`
// ImportErrors corresponds to the JSON schema field "import_errors".
ImportErrors *ImportErrors `msgpack:"import_errors,omitempty"`
// SerializedDags corresponds to the JSON schema field "serialized_dags".
SerializedDags []LazyDeserializedDAG `msgpack:"serialized_dags"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Warnings corresponds to the JSON schema field "warnings".
Warnings *Warnings `msgpack:"warnings,omitempty"`
}
Result of DAG File Parsing.
This is the result of a successful DAG parse, in this class, we gather all serialized DAGs, import errors and warnings to send back to the scheduler to store in the DB.
type DagResult ¶
type DagResult struct {
// BundleName corresponds to the JSON schema field "bundle_name".
BundleName interface{} `msgpack:"bundle_name,omitempty"`
// BundleVersion corresponds to the JSON schema field "bundle_version".
BundleVersion interface{} `msgpack:"bundle_version,omitempty"`
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// IsPaused corresponds to the JSON schema field "is_paused".
IsPaused bool `msgpack:"is_paused"`
// NextDagrun corresponds to the JSON schema field "next_dagrun".
NextDagrun interface{} `msgpack:"next_dagrun,omitempty"`
// Owners corresponds to the JSON schema field "owners".
Owners interface{} `msgpack:"owners,omitempty"`
// RelativeFileloc corresponds to the JSON schema field "relative_fileloc".
RelativeFileloc interface{} `msgpack:"relative_fileloc,omitempty"`
// Tags corresponds to the JSON schema field "tags".
Tags []string `msgpack:"tags"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type DagRun ¶
type DagRun struct {
// ClearNumber corresponds to the JSON schema field "clear_number".
ClearNumber int `msgpack:"clear_number,omitempty"`
// Conf corresponds to the JSON schema field "conf".
Conf *Conf `msgpack:"conf,omitempty"`
// ConsumedAssetEvents corresponds to the JSON schema field
// "consumed_asset_events".
ConsumedAssetEvents []AssetEventDagRunReference `msgpack:"consumed_asset_events"`
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// DataIntervalEnd corresponds to the JSON schema field "data_interval_end".
DataIntervalEnd interface{} `msgpack:"data_interval_end"`
// DataIntervalStart corresponds to the JSON schema field "data_interval_start".
DataIntervalStart interface{} `msgpack:"data_interval_start"`
// EndDate corresponds to the JSON schema field "end_date".
EndDate interface{} `msgpack:"end_date"`
// LogicalDate corresponds to the JSON schema field "logical_date".
LogicalDate interface{} `msgpack:"logical_date"`
// Note corresponds to the JSON schema field "note".
Note interface{} `msgpack:"note,omitempty"`
// PartitionDate corresponds to the JSON schema field "partition_date".
PartitionDate interface{} `msgpack:"partition_date,omitempty"`
// PartitionKey corresponds to the JSON schema field "partition_key".
PartitionKey interface{} `msgpack:"partition_key"`
// RunAfter corresponds to the JSON schema field "run_after".
RunAfter time.Time `msgpack:"run_after"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// RunType corresponds to the JSON schema field "run_type".
RunType DagRunType `msgpack:"run_type"`
// StartDate corresponds to the JSON schema field "start_date".
StartDate interface{} `msgpack:"start_date"`
// State corresponds to the JSON schema field "state".
State DagRunState `msgpack:"state"`
// TeamName corresponds to the JSON schema field "team_name".
TeamName interface{} `msgpack:"team_name,omitempty"`
// TriggeringUserName corresponds to the JSON schema field "triggering_user_name".
TriggeringUserName interface{} `msgpack:"triggering_user_name,omitempty"`
}
Schema for DagRun model with minimal required fields needed for Runtime.
type DagRunAssetReference ¶
type DagRunAssetReference struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// DataIntervalEnd corresponds to the JSON schema field "data_interval_end".
DataIntervalEnd interface{} `msgpack:"data_interval_end,omitempty"`
// DataIntervalStart corresponds to the JSON schema field "data_interval_start".
DataIntervalStart interface{} `msgpack:"data_interval_start,omitempty"`
// EndDate corresponds to the JSON schema field "end_date".
EndDate interface{} `msgpack:"end_date,omitempty"`
// LogicalDate corresponds to the JSON schema field "logical_date".
LogicalDate interface{} `msgpack:"logical_date,omitempty"`
// PartitionKey corresponds to the JSON schema field "partition_key".
PartitionKey interface{} `msgpack:"partition_key,omitempty"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// StartDate corresponds to the JSON schema field "start_date".
StartDate time.Time `msgpack:"start_date"`
// State corresponds to the JSON schema field "state".
State string `msgpack:"state"`
}
DagRun serializer for asset responses.
type DagRunContext ¶
type DagRunContext struct {
// DagRun corresponds to the JSON schema field "dag_run".
DagRun *DagRun `msgpack:"dag_run,omitempty"`
// LastTI corresponds to the JSON schema field "last_ti".
LastTI *TaskInstance `msgpack:"last_ti,omitempty"`
}
Class to pass context info from the server to build a Execution context object.
type DagRunResult ¶
type DagRunResult struct {
// ClearNumber corresponds to the JSON schema field "clear_number".
ClearNumber interface{} `msgpack:"clear_number,omitempty"`
// Conf corresponds to the JSON schema field "conf".
Conf *Conf `msgpack:"conf,omitempty"`
// ConsumedAssetEvents corresponds to the JSON schema field
// "consumed_asset_events".
ConsumedAssetEvents []AssetEventDagRunReference `msgpack:"consumed_asset_events"`
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// DataIntervalEnd corresponds to the JSON schema field "data_interval_end".
DataIntervalEnd interface{} `msgpack:"data_interval_end,omitempty"`
// DataIntervalStart corresponds to the JSON schema field "data_interval_start".
DataIntervalStart interface{} `msgpack:"data_interval_start,omitempty"`
// EndDate corresponds to the JSON schema field "end_date".
EndDate interface{} `msgpack:"end_date,omitempty"`
// LogicalDate corresponds to the JSON schema field "logical_date".
LogicalDate interface{} `msgpack:"logical_date,omitempty"`
// Note corresponds to the JSON schema field "note".
Note interface{} `msgpack:"note,omitempty"`
// PartitionDate corresponds to the JSON schema field "partition_date".
PartitionDate interface{} `msgpack:"partition_date,omitempty"`
// PartitionKey corresponds to the JSON schema field "partition_key".
PartitionKey interface{} `msgpack:"partition_key,omitempty"`
// RunAfter corresponds to the JSON schema field "run_after".
RunAfter time.Time `msgpack:"run_after"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// RunType corresponds to the JSON schema field "run_type".
RunType DagRunType `msgpack:"run_type"`
// StartDate corresponds to the JSON schema field "start_date".
StartDate interface{} `msgpack:"start_date,omitempty"`
// State corresponds to the JSON schema field "state".
State DagRunState `msgpack:"state"`
// TeamName corresponds to the JSON schema field "team_name".
TeamName interface{} `msgpack:"team_name,omitempty"`
// TriggeringUserName corresponds to the JSON schema field "triggering_user_name".
TriggeringUserName interface{} `msgpack:"triggering_user_name,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
func (*DagRunResult) DecodeMsgpack ¶
func (m *DagRunResult) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies DagRunResult's schema defaults that msgpack would otherwise skip.
type DagRunState ¶
type DagRunState string
const DagRunStateFailed DagRunState = "failed"
const DagRunStateQueued DagRunState = "queued"
const DagRunStateRunning DagRunState = "running"
const DagRunStateSuccess DagRunState = "success"
type DagRunStateResult ¶
type DagRunStateResult struct {
// State corresponds to the JSON schema field "state".
State DagRunState `msgpack:"state"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type DagRunType ¶
type DagRunType string
const DagRunTypeAssetMaterialization DagRunType = "asset_materialization"
const DagRunTypeAssetTriggered DagRunType = "asset_triggered"
const DagRunTypeBackfill DagRunType = "backfill"
const DagRunTypeManual DagRunType = "manual"
const DagRunTypeOperatorTriggered DagRunType = "operator_triggered"
const DagRunTypeScheduled DagRunType = "scheduled"
type DeferTask ¶
type DeferTask struct {
// Classpath corresponds to the JSON schema field "classpath".
Classpath string `msgpack:"classpath"`
// NextKwargs corresponds to the JSON schema field "next_kwargs".
NextKwargs *NextKwargs `msgpack:"next_kwargs,omitempty"`
// NextMethod corresponds to the JSON schema field "next_method".
NextMethod string `msgpack:"next_method"`
// Queue corresponds to the JSON schema field "queue".
Queue interface{} `msgpack:"queue,omitempty"`
// RenderedMapIndex corresponds to the JSON schema field "rendered_map_index".
RenderedMapIndex interface{} `msgpack:"rendered_map_index,omitempty"`
// State corresponds to the JSON schema field "state".
State interface{} `msgpack:"state,omitempty"`
// TriggerKwargs corresponds to the JSON schema field "trigger_kwargs".
TriggerKwargs *TriggerKwargs `msgpack:"trigger_kwargs,omitempty"`
// TriggerTimeout corresponds to the JSON schema field "trigger_timeout".
TriggerTimeout interface{} `msgpack:"trigger_timeout,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Update a task instance state to deferred.
type DeleteTaskStateStore ¶
type DeleteVariable ¶
type DeleteXCom ¶
type DeleteXCom struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// MapIndex corresponds to the JSON schema field "map_index".
MapIndex interface{} `msgpack:"map_index,omitempty"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// TaskID corresponds to the JSON schema field "task_id".
TaskID string `msgpack:"task_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type EmailRequest ¶
type EmailRequest struct {
// BundleName corresponds to the JSON schema field "bundle_name".
BundleName string `msgpack:"bundle_name"`
// BundleVersion corresponds to the JSON schema field "bundle_version".
BundleVersion interface{} `msgpack:"bundle_version"`
// ContextFromServer corresponds to the JSON schema field "context_from_server".
ContextFromServer TIRunContext `msgpack:"context_from_server"`
// EmailType corresponds to the JSON schema field "email_type".
EmailType EmailRequestEmailType `msgpack:"email_type,omitempty"`
// Filepath corresponds to the JSON schema field "filepath".
Filepath string `msgpack:"filepath"`
// Msg corresponds to the JSON schema field "msg".
Msg interface{} `msgpack:"msg,omitempty"`
// TI corresponds to the JSON schema field "ti".
TI TaskInstance `msgpack:"ti"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Email notification request for task failures/retries.
func (*EmailRequest) DecodeMsgpack ¶
func (m *EmailRequest) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies EmailRequest's schema defaults that msgpack would otherwise skip.
type EmailRequestEmailType ¶
type EmailRequestEmailType string
const EmailRequestEmailTypeFailure EmailRequestEmailType = "failure"
const EmailRequestEmailTypeRetry EmailRequestEmailType = "retry"
type ErrorResponse ¶
type ErrorResponse struct {
// Detail corresponds to the JSON schema field "detail".
Detail *Detail `msgpack:"detail,omitempty"`
// Error corresponds to the JSON schema field "error".
Error ErrorType `msgpack:"error,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
func (*ErrorResponse) DecodeMsgpack ¶
func (m *ErrorResponse) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies ErrorResponse's schema defaults that msgpack would otherwise skip.
type ErrorType ¶
type ErrorType string
const ErrorTypeAPISERVERERROR ErrorType = "API_SERVER_ERROR"
const ErrorTypeASSETNOTFOUND ErrorType = "ASSET_NOT_FOUND"
const ErrorTypeASSETSTORENOTFOUND ErrorType = "ASSET_STORE_NOT_FOUND"
const ErrorTypeCONNECTIONNOTFOUND ErrorType = "CONNECTION_NOT_FOUND"
const ErrorTypeDAGRUNALREADYEXISTS ErrorType = "DAGRUN_ALREADY_EXISTS"
const ErrorTypeGENERICERROR ErrorType = "GENERIC_ERROR"
const ErrorTypePERMISSIONDENIED ErrorType = "PERMISSION_DENIED"
const ErrorTypeTASKSTORENOTFOUND ErrorType = "TASK_STORE_NOT_FOUND"
const ErrorTypeVARIABLENOTFOUND ErrorType = "VARIABLE_NOT_FOUND"
const ErrorTypeXCOMNOTFOUND ErrorType = "XCOM_NOT_FOUND"
type GetAssetByName ¶
type GetAssetByURI ¶
type GetAssetEventByAsset ¶
type GetAssetEventByAsset struct {
// After corresponds to the JSON schema field "after".
After interface{} `msgpack:"after,omitempty"`
// Ascending corresponds to the JSON schema field "ascending".
Ascending *bool `msgpack:"ascending,omitempty"`
// Before corresponds to the JSON schema field "before".
Before interface{} `msgpack:"before,omitempty"`
// Limit corresponds to the JSON schema field "limit".
Limit interface{} `msgpack:"limit,omitempty"`
// Name corresponds to the JSON schema field "name".
Name interface{} `msgpack:"name"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// URI corresponds to the JSON schema field "uri".
URI interface{} `msgpack:"uri"`
}
type GetAssetEventByAssetAlias ¶
type GetAssetEventByAssetAlias struct {
// After corresponds to the JSON schema field "after".
After interface{} `msgpack:"after,omitempty"`
// AliasName corresponds to the JSON schema field "alias_name".
AliasName string `msgpack:"alias_name"`
// Ascending corresponds to the JSON schema field "ascending".
Ascending *bool `msgpack:"ascending,omitempty"`
// Before corresponds to the JSON schema field "before".
Before interface{} `msgpack:"before,omitempty"`
// Limit corresponds to the JSON schema field "limit".
Limit interface{} `msgpack:"limit,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetAssetStateStoreByURI ¶
type GetAssetsByAlias ¶
type GetConnection ¶
type GetDRCount ¶
type GetDRCount struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// LogicalDates corresponds to the JSON schema field "logical_dates".
LogicalDates *LogicalDates `msgpack:"logical_dates,omitempty"`
// RunIds corresponds to the JSON schema field "run_ids".
RunIds *RunIds `msgpack:"run_ids,omitempty"`
// States corresponds to the JSON schema field "states".
States *States `msgpack:"states,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetDagRunState ¶
type GetHITLDetailResponse ¶
type GetHITLDetailResponse struct {
// TIID corresponds to the JSON schema field "ti_id".
TIID string `msgpack:"ti_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Get the response content part of a Human-in-the-loop response.
type GetPrevSuccessfulDagRun ¶
type GetPreviousDagRun ¶
type GetPreviousDagRun struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// LogicalDate corresponds to the JSON schema field "logical_date".
LogicalDate time.Time `msgpack:"logical_date"`
// State corresponds to the JSON schema field "state".
State interface{} `msgpack:"state,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetPreviousTI ¶
type GetPreviousTI struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// LogicalDate corresponds to the JSON schema field "logical_date".
LogicalDate interface{} `msgpack:"logical_date,omitempty"`
// MapIndex corresponds to the JSON schema field "map_index".
MapIndex *int `msgpack:"map_index,omitempty"`
// State corresponds to the JSON schema field "state".
State interface{} `msgpack:"state,omitempty"`
// TaskID corresponds to the JSON schema field "task_id".
TaskID string `msgpack:"task_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Request to get previous task instance.
type GetTICount ¶
type GetTICount struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// LogicalDates corresponds to the JSON schema field "logical_dates".
LogicalDates *LogicalDates `msgpack:"logical_dates,omitempty"`
// MapIndex corresponds to the JSON schema field "map_index".
MapIndex interface{} `msgpack:"map_index,omitempty"`
// RunIds corresponds to the JSON schema field "run_ids".
RunIds *RunIds `msgpack:"run_ids,omitempty"`
// States corresponds to the JSON schema field "states".
States *States `msgpack:"states,omitempty"`
// TaskGroupID corresponds to the JSON schema field "task_group_id".
TaskGroupID interface{} `msgpack:"task_group_id,omitempty"`
// TaskIds corresponds to the JSON schema field "task_ids".
TaskIds *TaskIds `msgpack:"task_ids,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetTaskBreadcrumbs ¶
type GetTaskBreadcrumbs struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetTaskRescheduleStartDate ¶
type GetTaskRescheduleStartDate struct {
// TIID corresponds to the JSON schema field "ti_id".
TIID string `msgpack:"ti_id"`
// TryNumber corresponds to the JSON schema field "try_number".
TryNumber *int `msgpack:"try_number,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetTaskStateStore ¶
type GetTaskStates ¶
type GetTaskStates struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// LogicalDates corresponds to the JSON schema field "logical_dates".
LogicalDates *LogicalDates `msgpack:"logical_dates,omitempty"`
// MapIndex corresponds to the JSON schema field "map_index".
MapIndex interface{} `msgpack:"map_index,omitempty"`
// RunIds corresponds to the JSON schema field "run_ids".
RunIds *RunIds `msgpack:"run_ids,omitempty"`
// TaskGroupID corresponds to the JSON schema field "task_group_id".
TaskGroupID interface{} `msgpack:"task_group_id,omitempty"`
// TaskIds corresponds to the JSON schema field "task_ids".
TaskIds *TaskIds `msgpack:"task_ids,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetVariable ¶
type GetVariableKeys ¶
type GetVariableKeys struct {
// Limit corresponds to the JSON schema field "limit".
Limit *int `msgpack:"limit,omitempty"`
// Offset corresponds to the JSON schema field "offset".
Offset int `msgpack:"offset,omitempty"`
// Prefix corresponds to the JSON schema field "prefix".
Prefix interface{} `msgpack:"prefix,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetXCom ¶
type GetXCom struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// IncludePriorDates corresponds to the JSON schema field "include_prior_dates".
IncludePriorDates bool `msgpack:"include_prior_dates,omitempty"`
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// MapIndex corresponds to the JSON schema field "map_index".
MapIndex interface{} `msgpack:"map_index,omitempty"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// TaskID corresponds to the JSON schema field "task_id".
TaskID string `msgpack:"task_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetXComCount ¶
type GetXComCount struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// TaskID corresponds to the JSON schema field "task_id".
TaskID string `msgpack:"task_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Get the number of (mapped) XCom values available.
type GetXComSequenceItem ¶
type GetXComSequenceItem struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// Offset corresponds to the JSON schema field "offset".
Offset int `msgpack:"offset"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// TaskID corresponds to the JSON schema field "task_id".
TaskID string `msgpack:"task_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type GetXComSequenceSlice ¶
type GetXComSequenceSlice struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// IncludePriorDates corresponds to the JSON schema field "include_prior_dates".
IncludePriorDates bool `msgpack:"include_prior_dates,omitempty"`
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// Start corresponds to the JSON schema field "start".
Start interface{} `msgpack:"start"`
// Step corresponds to the JSON schema field "step".
Step interface{} `msgpack:"step"`
// Stop corresponds to the JSON schema field "stop".
Stop interface{} `msgpack:"stop"`
// TaskID corresponds to the JSON schema field "task_id".
TaskID string `msgpack:"task_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type HITLDetailRequestResult ¶
type HITLDetailRequestResult struct {
// AssignedUsers corresponds to the JSON schema field "assigned_users".
AssignedUsers *AssignedUsers `msgpack:"assigned_users,omitempty"`
// Body corresponds to the JSON schema field "body".
Body interface{} `msgpack:"body,omitempty"`
// Defaults corresponds to the JSON schema field "defaults".
Defaults *Defaults `msgpack:"defaults,omitempty"`
// Multiple corresponds to the JSON schema field "multiple".
Multiple interface{} `msgpack:"multiple,omitempty"`
// Options corresponds to the JSON schema field "options".
Options []string `msgpack:"options"`
// Params corresponds to the JSON schema field "params".
Params *Params `msgpack:"params,omitempty"`
// Subject corresponds to the JSON schema field "subject".
Subject string `msgpack:"subject"`
// TIID corresponds to the JSON schema field "ti_id".
TIID string `msgpack:"ti_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Response to CreateHITLDetailPayload request.
func (*HITLDetailRequestResult) DecodeMsgpack ¶
func (m *HITLDetailRequestResult) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies HITLDetailRequestResult's schema defaults that msgpack would otherwise skip.
type HITLUser ¶
type HITLUser struct {
// ID corresponds to the JSON schema field "id".
ID string `msgpack:"id"`
// Name corresponds to the JSON schema field "name".
Name string `msgpack:"name"`
}
Schema for a Human-in-the-loop users.
type ImportErrors ¶
type InactiveAssets ¶
type InactiveAssets []AssetProfile
type InactiveAssetsResult ¶
type InactiveAssetsResult struct {
// InactiveAssets corresponds to the JSON schema field "inactive_assets".
InactiveAssets *InactiveAssets `msgpack:"inactive_assets,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Response of InactiveAssets requests.
type LazyDeserializedDAG ¶
type LazyDeserializedDAG struct {
// Data corresponds to the JSON schema field "data".
Data Data `msgpack:"data"`
// LastLoaded corresponds to the JSON schema field "last_loaded".
LastLoaded interface{} `msgpack:"last_loaded,omitempty"`
}
Lazily build information from the serialized DAG structure.
An object that will present "enough" of the DAG like interface to update DAG db models etc, without having to deserialize the full DAG and Task hierarchy.
type LogicalDates ¶
type MaskSecret ¶
type MaskSecret struct {
// Name corresponds to the JSON schema field "name".
Name interface{} `msgpack:"name,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Value corresponds to the JSON schema field "value".
Value JsonValue `msgpack:"value"`
}
Add a new value to be redacted in task logs.
type NextKwargs ¶
type OKResponse ¶
type OutletEvents ¶
type OutletEvents []map[string]interface{}
type ParamsInput ¶
type ParamsInput map[string]interface{}
type PrevSuccessfulDagRunResult ¶
type PrevSuccessfulDagRunResult struct {
// DataIntervalEnd corresponds to the JSON schema field "data_interval_end".
DataIntervalEnd interface{} `msgpack:"data_interval_end,omitempty"`
// DataIntervalStart corresponds to the JSON schema field "data_interval_start".
DataIntervalStart interface{} `msgpack:"data_interval_start,omitempty"`
// EndDate corresponds to the JSON schema field "end_date".
EndDate interface{} `msgpack:"end_date,omitempty"`
// StartDate corresponds to the JSON schema field "start_date".
StartDate interface{} `msgpack:"start_date,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type PreviousDagRunResult ¶
type PreviousDagRunResult struct {
// DagRun corresponds to the JSON schema field "dag_run".
DagRun *DagRun `msgpack:"dag_run,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Response containing previous Dag run information.
type PreviousTIResponse ¶
type PreviousTIResponse struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// Duration corresponds to the JSON schema field "duration".
Duration interface{} `msgpack:"duration,omitempty"`
// EndDate corresponds to the JSON schema field "end_date".
EndDate interface{} `msgpack:"end_date,omitempty"`
// LogicalDate corresponds to the JSON schema field "logical_date".
LogicalDate interface{} `msgpack:"logical_date,omitempty"`
// MapIndex corresponds to the JSON schema field "map_index".
MapIndex interface{} `msgpack:"map_index,omitempty"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// StartDate corresponds to the JSON schema field "start_date".
StartDate interface{} `msgpack:"start_date,omitempty"`
// State corresponds to the JSON schema field "state".
State interface{} `msgpack:"state,omitempty"`
// TaskID corresponds to the JSON schema field "task_id".
TaskID string `msgpack:"task_id"`
// TryNumber corresponds to the JSON schema field "try_number".
TryNumber int `msgpack:"try_number"`
}
Schema for response with previous TaskInstance information.
func (*PreviousTIResponse) DecodeMsgpack ¶
func (m *PreviousTIResponse) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies PreviousTIResponse's schema defaults that msgpack would otherwise skip.
type PreviousTIResult ¶
type PreviousTIResult struct {
// TaskInstance corresponds to the JSON schema field "task_instance".
TaskInstance *PreviousTIResponse `msgpack:"task_instance,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Response containing previous task instance data.
type PutVariable ¶
type PutVariable struct {
// Description corresponds to the JSON schema field "description".
Description interface{} `msgpack:"description"`
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Value corresponds to the JSON schema field "value".
Value interface{} `msgpack:"value"`
}
type RenderedFields ¶
type RescheduleTask ¶
type RescheduleTask struct {
// EndDate corresponds to the JSON schema field "end_date".
EndDate time.Time `msgpack:"end_date"`
// RescheduleDate corresponds to the JSON schema field "reschedule_date".
RescheduleDate time.Time `msgpack:"reschedule_date"`
// State corresponds to the JSON schema field "state".
State interface{} `msgpack:"state,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Update a task instance state to reschedule/up_for_reschedule.
func (*RescheduleTask) DecodeMsgpack ¶
func (m *RescheduleTask) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies RescheduleTask's schema defaults that msgpack would otherwise skip.
type ResendLoggingFD ¶
type ResendLoggingFD struct {
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type RetryTask ¶
type RetryTask struct {
// EndDate corresponds to the JSON schema field "end_date".
EndDate time.Time `msgpack:"end_date"`
// RenderedMapIndex corresponds to the JSON schema field "rendered_map_index".
RenderedMapIndex interface{} `msgpack:"rendered_map_index,omitempty"`
// RetryDelaySeconds corresponds to the JSON schema field "retry_delay_seconds".
RetryDelaySeconds interface{} `msgpack:"retry_delay_seconds,omitempty"`
// RetryReason corresponds to the JSON schema field "retry_reason".
RetryReason interface{} `msgpack:"retry_reason,omitempty"`
// State corresponds to the JSON schema field "state".
State interface{} `msgpack:"state,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Update a task instance state to up_for_retry.
type SetAssetStateStoreByName ¶
type SetAssetStateStoreByName struct {
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// Name corresponds to the JSON schema field "name".
Name string `msgpack:"name"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Value corresponds to the JSON schema field "value".
Value JsonValue `msgpack:"value"`
}
type SetAssetStateStoreByURI ¶
type SetAssetStateStoreByURI struct {
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// URI corresponds to the JSON schema field "uri".
URI string `msgpack:"uri"`
// Value corresponds to the JSON schema field "value".
Value JsonValue `msgpack:"value"`
}
type SetRenderedFields ¶
type SetRenderedFields struct {
// RenderedFields corresponds to the JSON schema field "rendered_fields".
RenderedFields RenderedFields `msgpack:"rendered_fields"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Payload for setting RTIF for a task instance.
type SetRenderedMapIndex ¶
type SetRenderedMapIndex struct {
// RenderedMapIndex corresponds to the JSON schema field "rendered_map_index".
RenderedMapIndex string `msgpack:"rendered_map_index"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Payload for setting rendered_map_index for a task instance.
type SetTaskStateStore ¶
type SetTaskStateStore struct {
// ExpiresAt corresponds to the JSON schema field "expires_at".
ExpiresAt interface{} `msgpack:"expires_at"`
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// TIID corresponds to the JSON schema field "ti_id".
TIID string `msgpack:"ti_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Value corresponds to the JSON schema field "value".
Value JsonValue `msgpack:"value"`
}
type SetXCom ¶
type SetXCom struct {
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// DagResult corresponds to the JSON schema field "dag_result".
DagResult bool `msgpack:"dag_result,omitempty"`
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// MapIndex corresponds to the JSON schema field "map_index".
MapIndex interface{} `msgpack:"map_index,omitempty"`
// MappedLength corresponds to the JSON schema field "mapped_length".
MappedLength interface{} `msgpack:"mapped_length,omitempty"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// TaskID corresponds to the JSON schema field "task_id".
TaskID string `msgpack:"task_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Value corresponds to the JSON schema field "value".
Value JsonValue `msgpack:"value"`
}
type SkipDownstreamTasks ¶
type SkipDownstreamTasks struct {
// Tasks corresponds to the JSON schema field "tasks".
Tasks []string `msgpack:"tasks"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Update state of downstream tasks within a task instance to 'skipped', while updating current task to success state.
type StartupDetails ¶
type StartupDetails struct {
// BundleInfo corresponds to the JSON schema field "bundle_info".
BundleInfo BundleInfo `msgpack:"bundle_info"`
// DagRelPath corresponds to the JSON schema field "dag_rel_path".
DagRelPath string `msgpack:"dag_rel_path"`
// SentryIntegration corresponds to the JSON schema field "sentry_integration".
SentryIntegration string `msgpack:"sentry_integration"`
// StartDate corresponds to the JSON schema field "start_date".
StartDate time.Time `msgpack:"start_date"`
// TI corresponds to the JSON schema field "ti".
TI TaskInstance `msgpack:"ti"`
// TIContext corresponds to the JSON schema field "ti_context".
TIContext TIRunContext `msgpack:"ti_context"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type SucceedTask ¶
type SucceedTask struct {
// EndDate corresponds to the JSON schema field "end_date".
EndDate time.Time `msgpack:"end_date"`
// OutletEvents corresponds to the JSON schema field "outlet_events".
OutletEvents *OutletEvents `msgpack:"outlet_events,omitempty"`
// RenderedMapIndex corresponds to the JSON schema field "rendered_map_index".
RenderedMapIndex interface{} `msgpack:"rendered_map_index,omitempty"`
// State corresponds to the JSON schema field "state".
State interface{} `msgpack:"state,omitempty"`
// TaskOutlets corresponds to the JSON schema field "task_outlets".
TaskOutlets *TaskOutlets `msgpack:"task_outlets,omitempty"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Update a task's state to success. Includes task_outlets and outlet_events for registering asset events.
func (*SucceedTask) DecodeMsgpack ¶
func (m *SucceedTask) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies SucceedTask's schema defaults that msgpack would otherwise skip.
type TICount ¶
type TICount struct {
// Count corresponds to the JSON schema field "count".
Count int `msgpack:"count"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Response containing count of Task Instances matching certain filters.
type TIRunContext ¶
type TIRunContext struct {
// Connections corresponds to the JSON schema field "connections".
Connections []ConnectionResponse `msgpack:"connections,omitempty"`
// DagRun corresponds to the JSON schema field "dag_run".
DagRun DagRun `msgpack:"dag_run"`
// MaxTries corresponds to the JSON schema field "max_tries".
MaxTries int `msgpack:"max_tries"`
// NextKwargs corresponds to the JSON schema field "next_kwargs".
NextKwargs *NextKwargs `msgpack:"next_kwargs,omitempty"`
// NextMethod corresponds to the JSON schema field "next_method".
NextMethod interface{} `msgpack:"next_method,omitempty"`
// ShouldRetry corresponds to the JSON schema field "should_retry".
ShouldRetry bool `msgpack:"should_retry,omitempty"`
// StartDate corresponds to the JSON schema field "start_date".
StartDate interface{} `msgpack:"start_date,omitempty"`
// TaskRescheduleCount corresponds to the JSON schema field
// "task_reschedule_count".
TaskRescheduleCount int `msgpack:"task_reschedule_count,omitempty"`
// Variables corresponds to the JSON schema field "variables".
Variables []VariableResponse `msgpack:"variables,omitempty"`
// XcomKeysToClear corresponds to the JSON schema field "xcom_keys_to_clear".
XcomKeysToClear []string `msgpack:"xcom_keys_to_clear,omitempty"`
}
Response schema for TaskInstance run context.
type TaskBreadcrumbsResult ¶
type TaskBreadcrumbsResult struct {
// Breadcrumbs corresponds to the JSON schema field "breadcrumbs".
Breadcrumbs []TaskBreadcrumbsResultBreadcrumbsElem `msgpack:"breadcrumbs"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type TaskBreadcrumbsResultBreadcrumbsElem ¶
type TaskBreadcrumbsResultBreadcrumbsElem map[string]interface{}
type TaskCallbackRequest ¶
type TaskCallbackRequest struct {
// BundleName corresponds to the JSON schema field "bundle_name".
BundleName string `msgpack:"bundle_name"`
// BundleVersion corresponds to the JSON schema field "bundle_version".
BundleVersion interface{} `msgpack:"bundle_version"`
// ContextFromServer corresponds to the JSON schema field "context_from_server".
ContextFromServer *TIRunContext `msgpack:"context_from_server,omitempty"`
// Filepath corresponds to the JSON schema field "filepath".
Filepath string `msgpack:"filepath"`
// Msg corresponds to the JSON schema field "msg".
Msg interface{} `msgpack:"msg,omitempty"`
// TaskCallbackType corresponds to the JSON schema field "task_callback_type".
TaskCallbackType interface{} `msgpack:"task_callback_type,omitempty"`
// TI corresponds to the JSON schema field "ti".
TI TaskInstance `msgpack:"ti"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Task callback status information.
A Class with information about the success/failure TI callback to be executed. Currently, only failure callbacks when tasks are externally killed or experience heartbeat timeouts are run via DagFileProcessorProcess.
type TaskInstance ¶
type TaskInstance struct {
// ContextCarrier corresponds to the JSON schema field "context_carrier".
ContextCarrier *ContextCarrier `msgpack:"context_carrier,omitempty"`
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// DagVersionID corresponds to the JSON schema field "dag_version_id".
DagVersionID string `msgpack:"dag_version_id"`
// Hostname corresponds to the JSON schema field "hostname".
Hostname interface{} `msgpack:"hostname,omitempty"`
// ID corresponds to the JSON schema field "id".
ID string `msgpack:"id"`
// MapIndex corresponds to the JSON schema field "map_index".
MapIndex *int `msgpack:"map_index,omitempty"`
// Queue corresponds to the JSON schema field "queue".
Queue string `msgpack:"queue,omitempty"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// TaskID corresponds to the JSON schema field "task_id".
TaskID string `msgpack:"task_id"`
// TryNumber corresponds to the JSON schema field "try_number".
TryNumber int `msgpack:"try_number"`
}
Schema for TaskInstance model with minimal required fields needed for Runtime.
func (*TaskInstance) DecodeMsgpack ¶
func (m *TaskInstance) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies TaskInstance's schema defaults that msgpack would otherwise skip.
type TaskInstanceState ¶
type TaskInstanceState string
const TaskInstanceStateAwaitingInput TaskInstanceState = "awaiting_input"
const TaskInstanceStateDeferred TaskInstanceState = "deferred"
const TaskInstanceStateFailed TaskInstanceState = "failed"
const TaskInstanceStateQueued TaskInstanceState = "queued"
const TaskInstanceStateRemoved TaskInstanceState = "removed"
const TaskInstanceStateRestarting TaskInstanceState = "restarting"
const TaskInstanceStateRunning TaskInstanceState = "running"
const TaskInstanceStateScheduled TaskInstanceState = "scheduled"
const TaskInstanceStateSkipped TaskInstanceState = "skipped"
const TaskInstanceStateSuccess TaskInstanceState = "success"
const TaskInstanceStateUpForReschedule TaskInstanceState = "up_for_reschedule"
const TaskInstanceStateUpForRetry TaskInstanceState = "up_for_retry"
const TaskInstanceStateUpstreamFailed TaskInstanceState = "upstream_failed"
type TaskOutlets ¶
type TaskOutlets []AssetProfile
type TaskRescheduleStartDate ¶
type TaskRescheduleStartDate struct {
// StartDate corresponds to the JSON schema field "start_date".
StartDate interface{} `msgpack:"start_date"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Response containing the first reschedule date for a task instance.
type TaskState ¶
type TaskState struct {
// EndDate corresponds to the JSON schema field "end_date".
EndDate interface{} `msgpack:"end_date,omitempty"`
// RenderedMapIndex corresponds to the JSON schema field "rendered_map_index".
RenderedMapIndex interface{} `msgpack:"rendered_map_index,omitempty"`
// State corresponds to the JSON schema field "state".
State TaskStateState `msgpack:"state"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Update a task's state.
If a process exits without sending one of these the state will be derived from the exit code: - 0 = SUCCESS - anything else = FAILED
type TaskStateState ¶
type TaskStateState string
const TaskStateStateFailed TaskStateState = "failed"
const TaskStateStateRemoved TaskStateState = "removed"
const TaskStateStateSkipped TaskStateState = "skipped"
type TaskStateStoreResult ¶
type TaskStateStoreResult struct {
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Value corresponds to the JSON schema field "value".
Value JsonValue `msgpack:"value"`
}
Response to GetTaskStateStore; wraps the generated API response for supervisor to worker comms.
type TaskStates ¶
type TaskStates map[string]interface{}
type TaskStatesResult ¶
type TaskStatesResult struct {
// TaskStates corresponds to the JSON schema field "task_states".
TaskStates TaskStates `msgpack:"task_states"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type TriggerDagRun ¶
type TriggerDagRun struct {
// Conf corresponds to the JSON schema field "conf".
Conf *Conf `msgpack:"conf,omitempty"`
// DagID corresponds to the JSON schema field "dag_id".
DagID string `msgpack:"dag_id"`
// LogicalDate corresponds to the JSON schema field "logical_date".
LogicalDate interface{} `msgpack:"logical_date,omitempty"`
// Note corresponds to the JSON schema field "note".
Note interface{} `msgpack:"note,omitempty"`
// PartitionKey corresponds to the JSON schema field "partition_key".
PartitionKey interface{} `msgpack:"partition_key,omitempty"`
// ResetDagRun corresponds to the JSON schema field "reset_dag_run".
ResetDagRun interface{} `msgpack:"reset_dag_run,omitempty"`
// RunAfter corresponds to the JSON schema field "run_after".
RunAfter interface{} `msgpack:"run_after,omitempty"`
// RunID corresponds to the JSON schema field "run_id".
RunID string `msgpack:"run_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
func (*TriggerDagRun) DecodeMsgpack ¶
func (m *TriggerDagRun) DecodeMsgpack(dec *msgpack.Decoder) error
DecodeMsgpack applies TriggerDagRun's schema defaults that msgpack would otherwise skip.
type TriggerKwargs ¶
type UpdateHITLDetail ¶
type UpdateHITLDetail struct {
// ChosenOptions corresponds to the JSON schema field "chosen_options".
ChosenOptions []string `msgpack:"chosen_options"`
// ParamsInput corresponds to the JSON schema field "params_input".
ParamsInput *ParamsInput `msgpack:"params_input,omitempty"`
// TIID corresponds to the JSON schema field "ti_id".
TIID string `msgpack:"ti_id"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
Update the response content part of an existing Human-in-the-loop response.
type VariableKeysResult ¶
type VariableKeysResult struct {
// Keys corresponds to the JSON schema field "keys".
Keys []string `msgpack:"keys"`
// TotalEntries corresponds to the JSON schema field "total_entries".
TotalEntries int `msgpack:"total_entries"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
}
type VariableResponse ¶
type VariableResponse struct {
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// Value corresponds to the JSON schema field "value".
Value interface{} `msgpack:"value"`
}
Variable schema for responses with fields that are needed for Runtime.
type VariableResult ¶
type VariableResult struct {
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Value corresponds to the JSON schema field "value".
Value interface{} `msgpack:"value,omitempty"`
}
type VersionData ¶
type VersionData map[string]interface{}
type XComCountResponse ¶
type XComResult ¶
type XComResult struct {
// Key corresponds to the JSON schema field "key".
Key string `msgpack:"key"`
// Type corresponds to the JSON schema field "type".
Type string `msgpack:"type,omitempty"`
// Value corresponds to the JSON schema field "value".
Value JsonValue `msgpack:"value"`
}
Response to ReadXCom request.