src/generated/supervisor.tstypescript
/*!
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
// AUTO-GENERATED by scripts/generate-supervisor.mjs — do not edit by hand.
// Source: ../task-sdk/src/airflow/sdk/execution_time/schema/schema.json
//
// Re-run with: pnpm run generate:supervisor
export type Name = string;
export type Id = number;
export type Timestamp = string;
export type Extra = {
[k: string]: JsonValue | null;
} | null;
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "JsonValue".
*/
export type JsonValue = {} | unknown[] | string | number | boolean | null;
export type Name1 = string;
export type Uri = string;
export type Group = string;
export type Extra1 = {
[k: string]: JsonValue | null;
} | null;
export type RunId = string;
export type DagId = string;
export type LogicalDate = string | null;
export type StartDate = string | null;
export type EndDate = string | null;
export type State = string;
export type DataIntervalStart = string | null;
export type DataIntervalEnd = string | null;
export type PartitionKey = string | null;
export type CreatedDagruns = DagRunAssetReference[];
export type SourceTaskId = string | null;
export type SourceDagId = string | null;
export type SourceRunId = string | null;
export type SourceMapIndex = number | null;
export type PartitionKey1 = string | null;
export type AssetEvents = AssetEventResponse[];
export type Type = "AssetEventsResult";
export type Name2 = string | null;
export type Uri1 = string | null;
export type Type1 = string;
export type Name3 = string;
export type Uri2 = string;
export type Group1 = string;
export type Extra2 = {
[k: string]: JsonValue | null;
} | null;
export type Type2 = "AssetResult";
export type Type3 = "AssetStateStoreResult";
export type Assets = AssetResult[];
export type Type4 = "AssetsByAliasResult";
export type State1 = "awaiting_input";
export type Timeout = string | null;
export type NextMethod = string;
export type NextKwargs = {
[k: string]: JsonValue | null;
} | null;
export type RenderedMapIndex = string | null;
export type Type5 = "AwaitInputTask";
export type Name4 = string;
export type Version = string | null;
export type VersionData = {
[k: string]: unknown;
} | null;
export type Name5 = string;
export type Type6 = "ClearAssetStateStoreByName";
export type Uri3 = string;
export type Type7 = "ClearAssetStateStoreByUri";
export type TiId = string;
export type Type8 = "ClearTaskStateStore";
export type ConnId = string;
export type ConnType = string;
export type Host = string | null;
export type Schema = string | null;
export type Login = string | null;
export type Password = string | null;
export type Port = number | null;
export type Extra3 = string | null;
export type ConnId1 = string;
export type ConnType1 = string;
export type Host1 = string | null;
export type Schema1 = string | null;
export type Login1 = string | null;
export type Password1 = string | null;
export type Port1 = number | null;
export type Extra4 = string | null;
export type Type9 = "ConnectionResult";
export type TiId1 = string;
/**
* @minItems 1
*/
export type Options = [string, ...string[]];
export type Subject = string;
export type Body = string | null;
export type Defaults = string[] | null;
export type Multiple = boolean | null;
export type Params = {
[k: string]: unknown;
} | null;
export type AssignedUsers = HITLUser[] | null;
export type Id1 = string;
export type Name6 = string;
export type Type10 = "CreateHITLDetailPayload";
export type Count = number;
export type Type11 = "DRCount";
export type Filepath = string;
export type BundleName = string;
export type BundleVersion = string | null;
export type VersionData1 = {
[k: string]: unknown;
} | null;
export type Msg = string | null;
export type DagId1 = string;
export type RunId1 = string;
export type DagId2 = string;
export type RunId2 = string;
export type LogicalDate1 = string | null;
export type DataIntervalStart1 = string | null;
export type DataIntervalEnd1 = string | null;
export type RunAfter = string;
export type StartDate1 = string | null;
export type EndDate1 = string | null;
export type ClearNumber = number;
/**
* Class with DagRun types.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagRunType".
*/
export type DagRunType =
| "backfill"
| "scheduled"
| "manual"
| "operator_triggered"
| "asset_triggered"
| "asset_materialization";
/**
* All possible states that a DagRun can be in.
*
* These are "shared" with TaskInstanceState in some parts of the code,
* so please ensure that their values always match the ones with the
* same name in TaskInstanceState.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagRunState".
*/
export type DagRunState = "queued" | "running" | "success" | "failed";
export type Conf = {
[k: string]: unknown;
} | null;
export type TriggeringUserName = string | null;
export type Name7 = string;
export type Uri4 = string;
export type SourceTaskId1 = string | null;
export type SourceDagId1 = string | null;
export type SourceRunId1 = string | null;
export type SourceMapIndex1 = number | null;
export type SourceAliases = AssetAliasReferenceAssetEventDagRun[];
export type Timestamp1 = string;
export type PartitionKey2 = string | null;
export type ConsumedAssetEvents = AssetEventDagRunReference[];
export type PartitionKey3 = string | null;
export type PartitionDate = string | null;
export type Note = string | null;
export type TeamName = string | null;
export type Id2 = string;
export type TaskId = string;
export type DagId3 = string;
export type RunId3 = string;
export type TryNumber = number;
export type DagVersionId = string;
export type MapIndex = number;
export type RegionId = string;
export type RegionIndex = number;
export type Hostname = string | null;
export type ContextCarrier = {
[k: string]: unknown;
} | null;
export type Queue = string;
export type IsFailureCallback = boolean | null;
export type Type12 = "DagCallbackRequest";
export type File = string;
export type BundlePath = string;
export type BundleName1 = string;
export type Filepath1 = string;
export type BundleName2 = string;
export type BundleVersion1 = string | null;
export type VersionData2 = {
[k: string]: unknown;
} | null;
export type Msg1 = string | null;
/**
* All possible states that a Task Instance can be in.
*
* Note that None is also allowed, so always use this in a type hint with Optional.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TaskInstanceState".
*/
export type TaskInstanceState =
| "removed"
| "scheduled"
| "queued"
| "running"
| "success"
| "restarting"
| "failed"
| "up_for_retry"
| "up_for_reschedule"
| "upstream_failed"
| "skipped"
| "deferred"
| "awaiting_input";
export type NodeId = string;
export type Index = number;
export type MaxIterations = number;
export type TerminalTaskId = string;
export type TerminalIsMapped = boolean;
export type RegionId1 = string;
export type Trajectory = number;
export type ForkedFromRegionId = string;
export type ResumesFromIndex = number;
export type ExpandedTiCount = number;
export type TaskRescheduleCount = number;
export type FirstTaskRescheduleStartDate = string | null;
export type MaxTries = number;
export type Key = string;
export type Value = string | null;
export type Variables = VariableResponse[];
export type Connections = ConnectionResponse[];
export type NextMethod1 = string | null;
export type NextKwargs1 =
| {
[k: string]: unknown;
}
| string
| null;
export type XcomKeysToClear = string[];
export type ShouldRetry = boolean;
export type StartDate2 = string | null;
export type ArgBindings = TaskArgBinding[] | null;
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TaskArgBinding".
*/
export type TaskArgBinding = XComArgBinding | LiteralArgBinding;
export type Name8 = string;
export type Kind = "xcom";
export type TaskId1 = string;
export type Name9 = string;
export type Kind1 = "literal";
export type FromDefault = boolean;
export type MultiTeam = boolean;
export type Type13 = "TaskCallbackRequest";
export type Filepath2 = string;
export type BundleName3 = string;
export type BundleVersion2 = string | null;
export type VersionData3 = {
[k: string]: unknown;
} | null;
export type Msg2 = string | null;
export type EmailType = "failure" | "retry";
export type Type14 = "EmailRequest";
export type CallbackRequests = (DagCallbackRequest | TaskCallbackRequest | EmailRequest)[];
export type Type15 = "DagFileParseRequest";
export type Fileloc = string;
export type LastLoaded = string | null;
export type SerializedDags = LazyDeserializedDAG[];
export type Warnings = unknown[] | null;
export type ImportErrors = {
[k: string]: string;
} | null;
export type ParsedDefinitions = string[];
export type SourceCode = string;
export type Language = string;
export type Type16 = "DagFileParsingResult";
export type DagId4 = string;
export type IsPaused = boolean;
export type BundleName4 = string | null;
export type BundleVersion3 = string | null;
export type RelativeFileloc = string | null;
export type Owners = string | null;
export type Tags = string[];
export type NextDagrun = string | null;
export type Type17 = "DagResult";
export type DagId5 = string;
export type RunId4 = string;
export type LogicalDate2 = string | null;
export type DataIntervalStart2 = string | null;
export type DataIntervalEnd2 = string | null;
export type RunAfter1 = string;
export type StartDate3 = string | null;
export type EndDate2 = string | null;
export type ClearNumber1 = number | null;
export type Conf1 = {
[k: string]: unknown;
} | null;
export type TriggeringUserName1 = string | null;
export type ConsumedAssetEvents1 = AssetEventDagRunReference[];
export type PartitionKey4 = string | null;
export type PartitionDate1 = string | null;
export type Note1 = string | null;
export type TeamName1 = string | null;
export type Type18 = "DagRunResult";
export type Type19 = "DagRunStateResult";
export type State2 = "deferred";
export type Classpath = string;
export type TriggerKwargs =
| {
[k: string]: JsonValue | null;
}
| string
| null;
export type TriggerTimeout = string | null;
export type Queue1 = string | null;
export type NextMethod2 = string;
export type NextKwargs2 = {
[k: string]: JsonValue | null;
} | null;
export type RenderedMapIndex1 = string | null;
export type Type20 = "DeferTask";
export type Name10 = string;
export type Key1 = string;
export type Type21 = "DeleteAssetStateStoreByName";
export type Uri5 = string;
export type Key2 = string;
export type Type22 = "DeleteAssetStateStoreByUri";
export type TiId2 = string;
export type Key3 = string;
export type Type23 = "DeleteTaskStateStore";
export type Key4 = string;
export type Type24 = "DeleteVariable";
export type Key5 = string;
export type DagId6 = string;
export type RunId5 = string;
export type TaskId2 = string;
export type MapIndex1 = number | null;
export type Type25 = "DeleteXCom";
/**
* Error types used in the API client.
*/
export type ErrorType =
| "CONNECTION_NOT_FOUND"
| "VARIABLE_NOT_FOUND"
| "XCOM_NOT_FOUND"
| "ASSET_NOT_FOUND"
| "TASK_STORE_NOT_FOUND"
| "ASSET_STORE_NOT_FOUND"
| "DAGRUN_ALREADY_EXISTS"
| "PERMISSION_DENIED"
| "GENERIC_ERROR"
| "API_SERVER_ERROR";
export type Detail = {
[k: string]: unknown;
} | null;
export type Type26 = "ErrorResponse";
/**
* Error types used in the API client.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ErrorType".
*/
export type ErrorType1 =
| "CONNECTION_NOT_FOUND"
| "VARIABLE_NOT_FOUND"
| "XCOM_NOT_FOUND"
| "ASSET_NOT_FOUND"
| "TASK_STORE_NOT_FOUND"
| "ASSET_STORE_NOT_FOUND"
| "DAGRUN_ALREADY_EXISTS"
| "PERMISSION_DENIED"
| "GENERIC_ERROR"
| "API_SERVER_ERROR";
export type Name11 = string;
export type Type27 = "GetAssetByName";
export type Uri6 = string;
export type Type28 = "GetAssetByUri";
export type Name12 = string | null;
export type Uri7 = string | null;
export type After = string | null;
export type Before = string | null;
export type Limit = number | null;
export type Ascending = boolean;
export type PartitionKey5 = string | null;
export type PartitionKeyRegexpPattern = string | null;
export type Extra7 = {
[k: string]: string;
} | null;
export type Type29 = "GetAssetEventByAsset";
export type AliasName = string;
export type After1 = string | null;
export type Before1 = string | null;
export type Limit1 = number | null;
export type Ascending1 = boolean;
export type PartitionKey6 = string | null;
export type PartitionKeyRegexpPattern1 = string | null;
export type Extra8 = {
[k: string]: string;
} | null;
export type Type30 = "GetAssetEventByAssetAlias";
export type Name13 = string;
export type Key6 = string;
export type Type31 = "GetAssetStateStoreByName";
export type Uri8 = string;
export type Key7 = string;
export type Type32 = "GetAssetStateStoreByUri";
export type AliasName1 = string;
export type Type33 = "GetAssetsByAlias";
export type ConnId2 = string;
export type Type34 = "GetConnection";
export type DagId7 = string;
export type LogicalDates = string[] | null;
export type RunIds = string[] | null;
export type States = string[] | null;
export type Type35 = "GetDRCount";
export type DagId8 = string;
export type Type36 = "GetDag";
export type DagId9 = string;
export type RunId6 = string;
export type Type37 = "GetDagRun";
export type DagId10 = string;
export type RunId7 = string;
export type Type38 = "GetDagRunState";
export type TiId3 = string;
export type Type39 = "GetHITLDetailResponse";
export type TiId4 = string;
export type Type40 = "GetPrevSuccessfulDagRun";
export type DagId11 = string;
export type LogicalDate3 = string;
export type State3 = string | null;
export type Type41 = "GetPreviousDagRun";
export type DagId12 = string;
export type TaskId3 = string;
export type LogicalDate4 = string | null;
export type MapIndex2 = number;
export type Type42 = "GetPreviousTI";
export type DagId13 = string;
export type MapIndex3 = number | null;
export type TaskIds = string[] | null;
export type TaskGroupId = string | null;
export type LogicalDates1 = string[] | null;
export type RunIds1 = string[] | null;
export type States1 = string[] | null;
export type Type43 = "GetTICount";
export type DagId14 = string;
export type RunId8 = string;
export type Type44 = "GetTaskBreadcrumbs";
export type TiId5 = string;
export type TryNumber1 = number;
export type Type45 = "GetTaskRescheduleStartDate";
export type TiId6 = string;
export type Key8 = string;
export type Type46 = "GetTaskStateStore";
export type DagId15 = string;
export type MapIndex4 = number | null;
export type TaskIds1 = string[] | null;
export type TaskGroupId1 = string | null;
export type LogicalDates2 = string[] | null;
export type RunIds2 = string[] | null;
export type Type47 = "GetTaskStates";
export type Key9 = string;
export type Type48 = "GetVariable";
export type Prefix = string | null;
export type Limit2 = number;
export type Offset = number;
export type Type49 = "GetVariableKeys";
export type PreviousIteration = boolean;
export type Key10 = string;
export type DagId16 = string;
export type RunId9 = string;
export type TaskId4 = string;
export type MapIndex5 = number | null;
export type IncludePriorDates = boolean;
export type Type50 = "GetXCom";
export type PreviousIteration1 = boolean;
export type Key11 = string;
export type DagId17 = string;
export type RunId10 = string;
export type TaskId5 = string;
export type Type51 = "GetXComCount";
export type PreviousIteration2 = boolean;
export type Key12 = string;
export type DagId18 = string;
export type RunId11 = string;
export type TaskId6 = string;
export type Offset1 = number;
export type Type52 = "GetXComSequenceItem";
export type PreviousIteration3 = boolean;
export type Key13 = string;
export type DagId19 = string;
export type RunId12 = string;
export type TaskId7 = string;
export type Start = number | null;
export type Stop = number | null;
export type Step = number | null;
export type IncludePriorDates1 = boolean;
export type Type53 = "GetXComSequenceSlice";
export type TiId7 = string;
/**
* @minItems 1
*/
export type Options1 = [string, ...string[]];
export type Subject1 = string;
export type Body1 = string | null;
export type Defaults1 = string[] | null;
export type Multiple1 = boolean | null;
export type Params1 = {
[k: string]: unknown;
} | null;
export type AssignedUsers1 = HITLUser[] | null;
export type Type54 = "HITLDetailRequestResult";
export type InactiveAssets = AssetProfile[] | null;
export type Type55 = "InactiveAssetsResult";
export type Stop1 = boolean;
export type Reason = string | null;
export type Name14 = string | null;
export type Type56 = "MaskSecret";
export type Ok = boolean;
export type Type57 = "OKResponse";
export type DataIntervalStart3 = string | null;
export type DataIntervalEnd3 = string | null;
export type StartDate4 = string | null;
export type EndDate3 = string | null;
export type Type58 = "PrevSuccessfulDagRunResult";
export type Type59 = "PreviousDagRunResult";
export type TaskId8 = string;
export type DagId20 = string;
export type RunId13 = string;
export type LogicalDate5 = string | null;
export type StartDate5 = string | null;
export type EndDate4 = string | null;
export type State4 = string | null;
export type TryNumber2 = number;
export type MapIndex6 = number | null;
export type RegionId2 = string | null;
export type RegionIndex1 = number | null;
export type Duration = number | null;
export type Type60 = "PreviousTIResult";
export type Key14 = string;
export type Value1 = string | null;
export type Description = string | null;
export type Type61 = "PutVariable";
export type State5 = "up_for_reschedule";
export type RescheduleDate = string;
export type EndDate5 = string;
export type Type62 = "RescheduleTask";
export type Type63 = "ResendLoggingFD";
export type State6 = "up_for_retry";
export type EndDate6 = string;
export type RenderedMapIndex2 = string | null;
export type RetryDelaySeconds = number | null;
export type RetryReason = string | null;
export type Type64 = "RetryTask";
export type Type65 = "SentFDs";
export type Fds = number[];
export type Name15 = string;
export type Key15 = string;
export type Type66 = "SetAssetStateStoreByName";
export type Uri9 = string;
export type Key16 = string;
export type Type67 = "SetAssetStateStoreByUri";
export type TimeoutSeconds = number;
export type Type68 = "SetExecutionTimeout";
export type Type69 = "SetRenderedFields";
export type RenderedMapIndex3 = string;
export type Type70 = "SetRenderedMapIndex";
export type TiId8 = string;
export type Key17 = string;
export type ExpiresAt = string | null;
export type Type71 = "SetTaskStateStore";
export type Key18 = string;
export type DagId21 = string;
export type RunId14 = string;
export type TaskId9 = string;
export type MapIndex7 = number | null;
export type DagResult1 = boolean;
export type MappedLength = number | null;
export type Type72 = "SetXCom";
export type Tasks = (string | [unknown, unknown])[];
export type Type73 = "SkipDownstreamTasks";
export type DagRelPath = string;
export type StartDate6 = string;
export type SentryIntegration = string;
export type Type74 = "StartupDetails";
export type State7 = "success";
export type EndDate7 = string;
export type TaskOutlets = AssetProfile[] | null;
export type OutletEvents =
| {
[k: string]: unknown;
}[]
| null;
export type RenderedMapIndex4 = string | null;
export type Type75 = "SucceedTask";
export type Count1 = number;
export type Type76 = "TICount";
export type Breadcrumbs = {
[k: string]: unknown;
}[];
export type Type77 = "TaskBreadcrumbsResult";
export type StartDate7 = string | null;
export type Type78 = "TaskRescheduleStartDate";
export type State8 = "failed" | "skipped" | "removed";
export type EndDate8 = string | null;
export type Type79 = "TaskState";
export type RenderedMapIndex5 = string | null;
export type RetryReason1 = string | null;
export type Type80 = "TaskStateStoreResult";
export type Type81 = "TaskStatesResult";
export type LogicalDate6 = string | null;
export type RunAfter2 = string | null;
export type Conf2 = {
[k: string]: unknown;
} | null;
export type ResetDagRun = boolean | null;
export type PartitionKey7 = string | null;
export type Note2 = string | null;
export type DagId22 = string;
export type DagRunId = string;
export type Type82 = "TriggerDagRun";
export type TiId9 = string;
export type Note3 = string | null;
export type Type83 = "UpdateDagRunNote";
export type TiId10 = string;
/**
* @minItems 1
*/
export type ChosenOptions = [string, ...string[]];
export type ParamsInput = {
[k: string]: unknown;
} | null;
export type Type84 = "UpdateHITLDetail";
export type TiId11 = string;
export type Type85 = "ValidateInletsAndOutlets";
export type Keys = string[];
export type TotalEntries = number;
export type Type86 = "VariableKeysResult";
export type Key19 = string;
export type Value2 = string | null;
export type Type87 = "VariableResult";
export type Len = number;
export type Type88 = "XComCountResponse";
export type Key20 = string;
export type Type89 = "XComResult";
export type Type90 = "XComSequenceIndexResult";
export type Root = JsonValue[];
export type Type91 = "XComSequenceSliceResult";
export interface SupervisorWireSchema {}
/**
* Schema for AssetAliasModel used in AssetEventDagRunReference.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetAliasReferenceAssetEventDagRun".
*/
export interface AssetAliasReferenceAssetEventDagRun {
name: Name;
}
/**
* Asset event schema with fields that are needed for Runtime.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetEventResponse".
*/
export interface AssetEventResponse {
id: Id;
timestamp: Timestamp;
extra?: Extra;
asset: AssetResponse;
created_dagruns: CreatedDagruns;
source_task_id?: SourceTaskId;
source_dag_id?: SourceDagId;
source_run_id?: SourceRunId;
source_map_index?: SourceMapIndex;
partition_key?: PartitionKey1;
}
/**
* Asset schema for responses with fields that are needed for Runtime.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetResponse".
*/
export interface AssetResponse {
name: Name1;
uri: Uri;
group: Group;
extra?: Extra1;
}
/**
* DagRun serializer for asset responses.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagRunAssetReference".
*/
export interface DagRunAssetReference {
run_id: RunId;
dag_id: DagId;
logical_date: LogicalDate;
start_date: StartDate;
end_date: EndDate;
state: State;
data_interval_start: DataIntervalStart;
data_interval_end: DataIntervalEnd;
partition_key: PartitionKey;
}
/**
* Response to GetAssetEvent request.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetEventsResult".
*/
export interface AssetEventsResult {
asset_events: AssetEvents;
type?: Type;
}
/**
* 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).
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetProfile".
*/
export interface AssetProfile {
name?: Name2;
uri?: Uri1;
type: Type1;
}
/**
* Response to ReadXCom request.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetResult".
*/
export interface AssetResult {
name: Name3;
uri: Uri2;
group: Group1;
extra?: Extra2;
type?: Type2;
}
/**
* Response to GetAssetStateStore; wraps the generated API response for supervisor to worker comms.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetStateStoreResult".
*/
export interface AssetStateStoreResult {
value: JsonValue | null;
type?: Type3;
}
/**
* Response to GetAssetsByAlias; list of concrete assets resolved from an alias.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetsByAliasResult".
*/
export interface AssetsByAliasResult {
assets: Assets;
type?: Type4;
}
/**
* Park a task instance awaiting human input (Human-in-the-loop), without a trigger.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AwaitInputTask".
*/
export interface AwaitInputTask {
state?: State1;
timeout?: Timeout;
next_method: NextMethod;
next_kwargs?: NextKwargs;
rendered_map_index?: RenderedMapIndex;
type?: Type5;
}
/**
* Schema for telling task which bundle to run with.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "BundleInfo".
*/
export interface BundleInfo {
name: Name4;
version?: Version;
version_data?: VersionData;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ClearAssetStateStoreByName".
*/
export interface ClearAssetStateStoreByName {
name: Name5;
type?: Type6;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ClearAssetStateStoreByUri".
*/
export interface ClearAssetStateStoreByUri {
uri: Uri3;
type?: Type7;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ClearTaskStateStore".
*/
export interface ClearTaskStateStore {
ti_id: TiId;
type?: Type8;
}
/**
* Connection schema for responses with fields that are needed for Runtime.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ConnectionResponse".
*/
export interface ConnectionResponse {
conn_id: ConnId;
conn_type: ConnType;
host: Host;
schema: Schema;
login: Login;
password: Password;
port: Port;
extra: Extra3;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ConnectionResult".
*/
export interface ConnectionResult {
conn_id: ConnId1;
conn_type: ConnType1;
host: Host1;
schema: Schema1;
login: Login1;
password: Password1;
port: Port1;
extra: Extra4;
type?: Type9;
}
/**
* Add the input request part of a Human-in-the-loop response.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "CreateHITLDetailPayload".
*/
export interface CreateHITLDetailPayload {
ti_id: TiId1;
options: Options;
subject: Subject;
body?: Body;
defaults?: Defaults;
multiple?: Multiple;
params?: Params;
assigned_users?: AssignedUsers;
type?: Type10;
}
/**
* Schema for a Human-in-the-loop users.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "HITLUser".
*/
export interface HITLUser {
id: Id1;
name: Name6;
}
/**
* Response containing count of Dag Runs matching certain filters.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DRCount".
*/
export interface DRCount {
count: Count;
type?: Type11;
}
/**
* A Class with information about the success/failure DAG callback to be executed.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagCallbackRequest".
*/
export interface DagCallbackRequest {
filepath: Filepath;
bundle_name: BundleName;
bundle_version: BundleVersion;
version_data?: VersionData1;
msg?: Msg;
dag_id: DagId1;
run_id: RunId1;
context_from_server?: DagRunContext | null;
is_failure_callback?: IsFailureCallback;
type?: Type12;
}
/**
* Class to pass context info from the server to build a Execution context object.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagRunContext".
*/
export interface DagRunContext {
dag_run?: DagRun | null;
last_ti?: TaskInstance | null;
}
/**
* Schema for DagRun model with minimal required fields needed for Runtime.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagRun".
*/
export interface DagRun {
dag_id: DagId2;
run_id: RunId2;
logical_date: LogicalDate1;
data_interval_start: DataIntervalStart1;
data_interval_end: DataIntervalEnd1;
run_after: RunAfter;
start_date: StartDate1;
end_date: EndDate1;
clear_number?: ClearNumber;
run_type: DagRunType;
state: DagRunState;
conf?: Conf;
triggering_user_name?: TriggeringUserName;
consumed_asset_events: ConsumedAssetEvents;
partition_key: PartitionKey3;
partition_date?: PartitionDate;
note?: Note;
team_name?: TeamName;
}
/**
* Schema for AssetEvent model used in DagRun.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetEventDagRunReference".
*/
export interface AssetEventDagRunReference {
asset: AssetReferenceAssetEventDagRun;
extra: Extra6;
source_task_id: SourceTaskId1;
source_dag_id: SourceDagId1;
source_run_id: SourceRunId1;
source_map_index: SourceMapIndex1;
source_aliases: SourceAliases;
timestamp: Timestamp1;
partition_key?: PartitionKey2;
}
/**
* Schema for AssetModel used in AssetEventDagRunReference.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "AssetReferenceAssetEventDagRun".
*/
export interface AssetReferenceAssetEventDagRun {
name: Name7;
uri: Uri4;
extra: Extra5;
}
export interface Extra5 {
[k: string]: JsonValue;
}
export interface Extra6 {
[k: string]: JsonValue;
}
/**
* Schema for TaskInstance model with minimal required fields needed for Runtime.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TaskInstance".
*/
export interface TaskInstance {
id: Id2;
task_id: TaskId;
dag_id: DagId3;
run_id: RunId3;
try_number: TryNumber;
dag_version_id: DagVersionId;
map_index?: MapIndex;
region_id?: RegionId;
region_index?: RegionIndex;
hostname?: Hostname;
context_carrier?: ContextCarrier;
queue?: Queue;
}
/**
* 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.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagFileParseRequest".
*/
export interface DagFileParseRequest {
file: File;
bundle_path: BundlePath;
bundle_name: BundleName1;
callback_requests?: CallbackRequests;
type?: Type15;
}
/**
* 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.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TaskCallbackRequest".
*/
export interface TaskCallbackRequest {
filepath: Filepath1;
bundle_name: BundleName2;
bundle_version: BundleVersion1;
version_data?: VersionData2;
msg?: Msg1;
ti: TaskInstance;
task_callback_type?: TaskInstanceState | null;
context_from_server?: TIRunContext | null;
type?: Type13;
}
/**
* Response schema for TaskInstance run context.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TIRunContext".
*/
export interface TIRunContext {
dag_run: DagRun;
loop?: LoopContext | null;
expanded_ti_count?: ExpandedTiCount;
task_reschedule_count?: TaskRescheduleCount;
first_task_reschedule_start_date?: FirstTaskRescheduleStartDate;
max_tries: MaxTries;
variables?: Variables;
connections?: Connections;
next_method?: NextMethod1;
next_kwargs?: NextKwargs1;
xcom_keys_to_clear?: XcomKeysToClear;
should_retry?: ShouldRetry;
start_date?: StartDate2;
arg_bindings?: ArgBindings;
multi_team?: MultiTeam;
}
/**
* Pinned loop definition and enclosing iteration for a task execution.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "LoopContext".
*/
export interface LoopContext {
node_id: NodeId;
index: Index;
max_iterations: MaxIterations;
terminal_task_id: TerminalTaskId;
terminal_is_mapped: TerminalIsMapped;
region_id: RegionId1;
trajectory: Trajectory;
forked_from_region_id?: ForkedFromRegionId;
resumes_from_index?: ResumesFromIndex;
}
/**
* Variable schema for responses with fields that are needed for Runtime.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "VariableResponse".
*/
export interface VariableResponse {
key: Key;
value: Value;
}
/**
* One positional stub-task argument pulled from an upstream task's XCom.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "XComArgBinding".
*/
export interface XComArgBinding {
name: Name8;
value_schema?: ArgValueSchema | null;
kind: Kind;
task_id: TaskId1;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ArgValueSchema".
*/
export interface ArgValueSchema {
[k: string]: JsonValue;
}
/**
* One positional stub-task argument carrying an inline literal from the Dag file.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "LiteralArgBinding".
*/
export interface LiteralArgBinding {
name: Name9;
value_schema?: ArgValueSchema | null;
kind: Kind1;
value?: JsonValue | null;
from_default?: FromDefault;
}
/**
* Email notification request for task failures/retries.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "EmailRequest".
*/
export interface EmailRequest {
filepath: Filepath2;
bundle_name: BundleName3;
bundle_version: BundleVersion2;
version_data?: VersionData3;
msg?: Msg2;
ti: TaskInstance;
email_type?: EmailType;
context_from_server: TIRunContext;
type?: Type14;
}
/**
* 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.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagFileParsingResult".
*/
export interface DagFileParsingResult {
fileloc: Fileloc;
serialized_dags: SerializedDags;
warnings?: Warnings;
import_errors?: ImportErrors;
parsed_definitions?: ParsedDefinitions;
dag_source_codes?: DagSourceCodes;
type?: Type16;
}
/**
* 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.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "LazyDeserializedDAG".
*/
export interface LazyDeserializedDAG {
data: Data;
last_loaded?: LastLoaded;
}
export interface Data {
[k: string]: unknown;
}
export interface DagSourceCodes {
[k: string]: DagSourceCode;
}
/**
* Raw source code and its language identifier for a DAG definition.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagSourceCode".
*/
export interface DagSourceCode {
source_code: SourceCode;
language: Language;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagResult".
*/
export interface DagResult {
dag_id: DagId4;
is_paused: IsPaused;
bundle_name: BundleName4;
bundle_version: BundleVersion3;
relative_fileloc: RelativeFileloc;
owners: Owners;
tags: Tags;
next_dagrun: NextDagrun;
type?: Type17;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagRunResult".
*/
export interface DagRunResult {
dag_id: DagId5;
run_id: RunId4;
logical_date: LogicalDate2;
data_interval_start: DataIntervalStart2;
data_interval_end: DataIntervalEnd2;
run_after: RunAfter1;
start_date: StartDate3;
end_date: EndDate2;
clear_number?: ClearNumber1;
run_type: DagRunType;
state: DagRunState;
conf?: Conf1;
triggering_user_name?: TriggeringUserName1;
consumed_asset_events: ConsumedAssetEvents1;
partition_key: PartitionKey4;
partition_date?: PartitionDate1;
note?: Note1;
team_name?: TeamName1;
type?: Type18;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DagRunStateResult".
*/
export interface DagRunStateResult {
state: DagRunState;
type?: Type19;
}
/**
* Update a task instance state to deferred.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DeferTask".
*/
export interface DeferTask {
state?: State2;
classpath: Classpath;
trigger_kwargs?: TriggerKwargs;
trigger_timeout?: TriggerTimeout;
queue?: Queue1;
next_method: NextMethod2;
next_kwargs?: NextKwargs2;
rendered_map_index?: RenderedMapIndex1;
type?: Type20;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DeleteAssetStateStoreByName".
*/
export interface DeleteAssetStateStoreByName {
name: Name10;
key: Key1;
type?: Type21;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DeleteAssetStateStoreByUri".
*/
export interface DeleteAssetStateStoreByUri {
uri: Uri5;
key: Key2;
type?: Type22;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DeleteTaskStateStore".
*/
export interface DeleteTaskStateStore {
ti_id: TiId2;
key: Key3;
type?: Type23;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DeleteVariable".
*/
export interface DeleteVariable {
key: Key4;
type?: Type24;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "DeleteXCom".
*/
export interface DeleteXCom {
key: Key5;
dag_id: DagId6;
run_id: RunId5;
task_id: TaskId2;
map_index?: MapIndex1;
type?: Type25;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ErrorResponse".
*/
export interface ErrorResponse {
error?: ErrorType;
detail?: Detail;
type?: Type26;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetAssetByName".
*/
export interface GetAssetByName {
name: Name11;
type?: Type27;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetAssetByUri".
*/
export interface GetAssetByUri {
uri: Uri6;
type?: Type28;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetAssetEventByAsset".
*/
export interface GetAssetEventByAsset {
name: Name12;
uri: Uri7;
after?: After;
before?: Before;
limit?: Limit;
ascending?: Ascending;
partition_key?: PartitionKey5;
partition_key_regexp_pattern?: PartitionKeyRegexpPattern;
extra?: Extra7;
type?: Type29;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetAssetEventByAssetAlias".
*/
export interface GetAssetEventByAssetAlias {
alias_name: AliasName;
after?: After1;
before?: Before1;
limit?: Limit1;
ascending?: Ascending1;
partition_key?: PartitionKey6;
partition_key_regexp_pattern?: PartitionKeyRegexpPattern1;
extra?: Extra8;
type?: Type30;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetAssetStateStoreByName".
*/
export interface GetAssetStateStoreByName {
name: Name13;
key: Key6;
type?: Type31;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetAssetStateStoreByUri".
*/
export interface GetAssetStateStoreByUri {
uri: Uri8;
key: Key7;
type?: Type32;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetAssetsByAlias".
*/
export interface GetAssetsByAlias {
alias_name: AliasName1;
type?: Type33;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetConnection".
*/
export interface GetConnection {
conn_id: ConnId2;
type?: Type34;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetDRCount".
*/
export interface GetDRCount {
dag_id: DagId7;
logical_dates?: LogicalDates;
run_ids?: RunIds;
states?: States;
type?: Type35;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetDag".
*/
export interface GetDag {
dag_id: DagId8;
type?: Type36;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetDagRun".
*/
export interface GetDagRun {
dag_id: DagId9;
run_id: RunId6;
type?: Type37;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetDagRunState".
*/
export interface GetDagRunState {
dag_id: DagId10;
run_id: RunId7;
type?: Type38;
}
/**
* Get the response content part of a Human-in-the-loop response.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetHITLDetailResponse".
*/
export interface GetHITLDetailResponse {
ti_id: TiId3;
type?: Type39;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetPrevSuccessfulDagRun".
*/
export interface GetPrevSuccessfulDagRun {
ti_id: TiId4;
type?: Type40;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetPreviousDagRun".
*/
export interface GetPreviousDagRun {
dag_id: DagId11;
logical_date: LogicalDate3;
state?: State3;
type?: Type41;
}
/**
* Request to get previous task instance.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetPreviousTI".
*/
export interface GetPreviousTI {
dag_id: DagId12;
task_id: TaskId3;
logical_date?: LogicalDate4;
map_index?: MapIndex2;
state?: TaskInstanceState | null;
type?: Type42;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetTICount".
*/
export interface GetTICount {
dag_id: DagId13;
map_index?: MapIndex3;
task_ids?: TaskIds;
task_group_id?: TaskGroupId;
logical_dates?: LogicalDates1;
run_ids?: RunIds1;
states?: States1;
type?: Type43;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetTaskBreadcrumbs".
*/
export interface GetTaskBreadcrumbs {
dag_id: DagId14;
run_id: RunId8;
type?: Type44;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetTaskRescheduleStartDate".
*/
export interface GetTaskRescheduleStartDate {
ti_id: TiId5;
try_number?: TryNumber1;
type?: Type45;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetTaskStateStore".
*/
export interface GetTaskStateStore {
ti_id: TiId6;
key: Key8;
type?: Type46;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetTaskStates".
*/
export interface GetTaskStates {
dag_id: DagId15;
map_index?: MapIndex4;
task_ids?: TaskIds1;
task_group_id?: TaskGroupId1;
logical_dates?: LogicalDates2;
run_ids?: RunIds2;
type?: Type47;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetVariable".
*/
export interface GetVariable {
key: Key9;
type?: Type48;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetVariableKeys".
*/
export interface GetVariableKeys {
prefix?: Prefix;
limit?: Limit2;
offset?: Offset;
type?: Type49;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetXCom".
*/
export interface GetXCom {
previous_iteration?: PreviousIteration;
key: Key10;
dag_id: DagId16;
run_id: RunId9;
task_id: TaskId4;
map_index?: MapIndex5;
include_prior_dates?: IncludePriorDates;
type?: Type50;
}
/**
* Get the number of (mapped) XCom values available.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetXComCount".
*/
export interface GetXComCount {
previous_iteration?: PreviousIteration1;
key: Key11;
dag_id: DagId17;
run_id: RunId10;
task_id: TaskId5;
type?: Type51;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetXComSequenceItem".
*/
export interface GetXComSequenceItem {
previous_iteration?: PreviousIteration2;
key: Key12;
dag_id: DagId18;
run_id: RunId11;
task_id: TaskId6;
offset: Offset1;
type?: Type52;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "GetXComSequenceSlice".
*/
export interface GetXComSequenceSlice {
previous_iteration?: PreviousIteration3;
key: Key13;
dag_id: DagId19;
run_id: RunId12;
task_id: TaskId7;
start: Start;
stop: Stop;
step: Step;
include_prior_dates?: IncludePriorDates1;
type?: Type53;
}
/**
* Response to CreateHITLDetailPayload request.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "HITLDetailRequestResult".
*/
export interface HITLDetailRequestResult {
ti_id: TiId7;
options: Options1;
subject: Subject1;
body?: Body1;
defaults?: Defaults1;
multiple?: Multiple1;
params?: Params1;
assigned_users?: AssignedUsers1;
type?: Type54;
}
/**
* Response of InactiveAssets requests.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "InactiveAssetsResult".
*/
export interface InactiveAssetsResult {
inactive_assets?: InactiveAssets;
type?: Type55;
}
/**
* A loop gate's evaluation of its ``until`` callable.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "LoopDecisionPayload".
*/
export interface LoopDecisionPayload {
stop: Stop1;
reason?: Reason;
}
/**
* Add a new value to be redacted in task logs.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "MaskSecret".
*/
export interface MaskSecret {
value: JsonValue;
name?: Name14;
type?: Type56;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "OKResponse".
*/
export interface OKResponse {
ok: Ok;
type?: Type57;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "PrevSuccessfulDagRunResult".
*/
export interface PrevSuccessfulDagRunResult {
data_interval_start?: DataIntervalStart3;
data_interval_end?: DataIntervalEnd3;
start_date?: StartDate4;
end_date?: EndDate3;
type?: Type58;
}
/**
* Response containing previous Dag run information.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "PreviousDagRunResult".
*/
export interface PreviousDagRunResult {
dag_run?: DagRun | null;
type?: Type59;
}
/**
* Schema for response with previous TaskInstance information.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "PreviousTIResponse".
*/
export interface PreviousTIResponse {
task_id: TaskId8;
dag_id: DagId20;
run_id: RunId13;
logical_date?: LogicalDate5;
start_date?: StartDate5;
end_date?: EndDate4;
state?: State4;
try_number: TryNumber2;
map_index?: MapIndex6;
region_id?: RegionId2;
region_index?: RegionIndex1;
duration?: Duration;
}
/**
* Response containing previous task instance data.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "PreviousTIResult".
*/
export interface PreviousTIResult {
task_instance?: PreviousTIResponse | null;
type?: Type60;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "PutVariable".
*/
export interface PutVariable {
key: Key14;
value: Value1;
description: Description;
type?: Type61;
}
/**
* Update a task instance state to reschedule/up_for_reschedule.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "RescheduleTask".
*/
export interface RescheduleTask {
state?: State5;
reschedule_date: RescheduleDate;
end_date: EndDate5;
type?: Type62;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ResendLoggingFD".
*/
export interface ResendLoggingFD {
type?: Type63;
}
/**
* Update a task instance state to up_for_retry.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "RetryTask".
*/
export interface RetryTask {
state?: State6;
end_date: EndDate6;
rendered_map_index?: RenderedMapIndex2;
retry_delay_seconds?: RetryDelaySeconds;
retry_reason?: RetryReason;
type?: Type64;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SentFDs".
*/
export interface SentFDs {
type?: Type65;
fds: Fds;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SetAssetStateStoreByName".
*/
export interface SetAssetStateStoreByName {
name: Name15;
key: Key15;
value: JsonValue;
type?: Type66;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SetAssetStateStoreByUri".
*/
export interface SetAssetStateStoreByUri {
uri: Uri9;
key: Key16;
value: JsonValue;
type?: Type67;
}
/**
* Tell the supervisor the task's ``execution_timeout`` so it can enforce it from outside the task process.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SetExecutionTimeout".
*/
export interface SetExecutionTimeout {
timeout_seconds: TimeoutSeconds;
type?: Type68;
}
/**
* Payload for setting RTIF for a task instance.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SetRenderedFields".
*/
export interface SetRenderedFields {
rendered_fields: RenderedFields;
type?: Type69;
}
export interface RenderedFields {
[k: string]: JsonValue;
}
/**
* Payload for setting rendered_map_index for a task instance.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SetRenderedMapIndex".
*/
export interface SetRenderedMapIndex {
rendered_map_index: RenderedMapIndex3;
type?: Type70;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SetTaskStateStore".
*/
export interface SetTaskStateStore {
ti_id: TiId8;
key: Key17;
value: JsonValue;
expires_at: ExpiresAt;
type?: Type71;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SetXCom".
*/
export interface SetXCom {
key: Key18;
value: JsonValue;
dag_id: DagId21;
run_id: RunId14;
task_id: TaskId9;
map_index?: MapIndex7;
dag_result?: DagResult1;
mapped_length?: MappedLength;
type?: Type72;
}
/**
* Update state of downstream tasks within a task instance to 'skipped', while updating current task to success state.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SkipDownstreamTasks".
*/
export interface SkipDownstreamTasks {
tasks: Tasks;
type?: Type73;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "StartupDetails".
*/
export interface StartupDetails {
ti: TaskInstance;
dag_rel_path: DagRelPath;
bundle_info: BundleInfo;
start_date: StartDate6;
ti_context: TIRunContext;
sentry_integration: SentryIntegration;
type?: Type74;
}
/**
* Update a task's state to success. Includes task_outlets and outlet_events for registering asset events.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "SucceedTask".
*/
export interface SucceedTask {
state?: State7;
end_date: EndDate7;
task_outlets?: TaskOutlets;
outlet_events?: OutletEvents;
rendered_map_index?: RenderedMapIndex4;
loop_decision?: LoopDecisionPayload | null;
type?: Type75;
}
/**
* Response containing count of Task Instances matching certain filters.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TICount".
*/
export interface TICount {
count: Count1;
type?: Type76;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TaskBreadcrumbsResult".
*/
export interface TaskBreadcrumbsResult {
breadcrumbs: Breadcrumbs;
type?: Type77;
}
/**
* Response containing the first reschedule date for a task instance.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TaskRescheduleStartDate".
*/
export interface TaskRescheduleStartDate {
start_date: StartDate7;
type?: Type78;
}
/**
* 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
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TaskState".
*/
export interface TaskState {
state: State8;
end_date?: EndDate8;
type?: Type79;
rendered_map_index?: RenderedMapIndex5;
retry_reason?: RetryReason1;
loop_decision?: LoopDecisionPayload | null;
}
/**
* Response to GetTaskStateStore; wraps the generated API response for supervisor to worker comms.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TaskStateStoreResult".
*/
export interface TaskStateStoreResult {
value: JsonValue | null;
type?: Type80;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TaskStatesResult".
*/
export interface TaskStatesResult {
task_states: TaskStates;
type?: Type81;
}
export interface TaskStates {
[k: string]: unknown;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "TriggerDagRun".
*/
export interface TriggerDagRun {
logical_date?: LogicalDate6;
run_after?: RunAfter2;
conf?: Conf2;
reset_dag_run?: ResetDagRun;
partition_key?: PartitionKey7;
note?: Note2;
dag_id: DagId22;
run_id: DagRunId;
type?: Type82;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "UpdateDagRunNote".
*/
export interface UpdateDagRunNote {
ti_id: TiId9;
note: Note3;
type?: Type83;
}
/**
* Update the response content part of an existing Human-in-the-loop response.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "UpdateHITLDetail".
*/
export interface UpdateHITLDetail {
ti_id: TiId10;
chosen_options: ChosenOptions;
params_input?: ParamsInput;
type?: Type84;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "ValidateInletsAndOutlets".
*/
export interface ValidateInletsAndOutlets {
ti_id: TiId11;
type?: Type85;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "VariableKeysResult".
*/
export interface VariableKeysResult {
keys: Keys;
total_entries: TotalEntries;
type?: Type86;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "VariableResult".
*/
export interface VariableResult {
key: Key19;
value: Value2;
type?: Type87;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "XComCountResponse".
*/
export interface XComCountResponse {
len: Len;
type?: Type88;
}
/**
* Response to ReadXCom request.
*
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "XComResult".
*/
export interface XComResult {
key: Key20;
value: JsonValue | null;
type?: Type89;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "XComSequenceIndexResult".
*/
export interface XComSequenceIndexResult {
root: JsonValue;
type?: Type90;
}
/**
* This interface was referenced by `SupervisorWireSchema`'s JSON-Schema
* via the `definition` "XComSequenceSliceResult".
*/
export interface XComSequenceSliceResult {
root: Root;
type?: Type91;
}
/** Cadwyn schema version this SDK was generated against.
* Not transmitted on the wire — the supervisor learns it out-of-band
* (e.g. bundle metadata) and runs the migrator accordingly.
* Exposed so the SDK author / operator can confirm which schema
* version their build is pinned to. */
export const SUPERVISOR_API_VERSION = "2026-10-30" as const;