api

package
v0.0.0-...-a18fc01 Latest Latest
Warning

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

Go to latest
Published: Oct 6, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const API_VERSION = "2025-05-20"
View Source
const (
	JWTBearerScopes = "JWTBearer.Scopes"
)

Variables

View Source
var (
	Hostname string
	Username string
)

Functions

func HandleError

func HandleError(client *resty.Client, resp *resty.Response) error

Types

type AssetAliasReferenceAssetEventDagRun

type AssetAliasReferenceAssetEventDagRun struct {
	Name string `json:"name"`
}

AssetAliasReferenceAssetEventDagRun Schema for AssetAliasModel used in AssetEventDagRunReference.

type AssetEventDagRunReference

type AssetEventDagRunReference struct {
	// Asset Schema for AssetModel used in AssetEventDagRunReference.
	Asset          AssetReferenceAssetEventDagRun        `json:"asset"`
	Extra          map[string]interface{}                `json:"extra"`
	SourceAliases  []AssetAliasReferenceAssetEventDagRun `json:"source_aliases"`
	SourceDagId    *string                               `json:"source_dag_id"`
	SourceMapIndex *int                                  `json:"source_map_index"`
	SourceRunId    *string                               `json:"source_run_id"`
	SourceTaskId   *string                               `json:"source_task_id"`
	Timestamp      time.Time                             `json:"timestamp"`
}

AssetEventDagRunReference Schema for AssetEvent model used in DagRun.

type AssetEventResponse

type AssetEventResponse struct {
	// Asset Asset schema for responses with fields that are needed for Runtime.
	Asset          AssetResponse           `json:"asset"`
	CreatedDagruns []DagRunAssetReference  `json:"created_dagruns"`
	Extra          *map[string]interface{} `json:"extra"`
	Id             int                     `json:"id"`
	SourceDagId    *string                 `json:"source_dag_id"`
	SourceMapIndex *int                    `json:"source_map_index,omitempty"`
	SourceRunId    *string                 `json:"source_run_id"`
	SourceTaskId   *string                 `json:"source_task_id"`
	Timestamp      time.Time               `json:"timestamp"`
}

AssetEventResponse Asset event schema with fields that are needed for Runtime.

type AssetEventsClient

type AssetEventsClient interface {
	GetByAssetNameUri(ctx context.Context, params *GetAssetEventByAssetNameUriParams) (*AssetEventsResponse, error)
	// GetByAssetNameUriResponse is a lower level version of [GetByAssetNameUri] and provides access to the raw [resty.Response]
	GetByAssetNameUriResponse(ctx context.Context, params *GetAssetEventByAssetNameUriParams) (*resty.Response, error)

	GetByAssetAlias(ctx context.Context, params *GetAssetEventByAssetAliasParams) (*AssetEventsResponse, error)
	// GetByAssetAliasResponse is a lower level version of [GetByAssetAlias] and provides access to the raw [resty.Response]
	GetByAssetAliasResponse(ctx context.Context, params *GetAssetEventByAssetAliasParams) (*resty.Response, error)
}

type AssetEventsResponse

type AssetEventsResponse struct {
	AssetEvents []AssetEventResponse `json:"asset_events"`
}

AssetEventsResponse Collection of AssetEventResponse.

type AssetProfile

type AssetProfile struct {
	Name *string `json:"name"`
	Type string  `json:"type"`
	Uri  *string `json:"uri"`
}

AssetProfile 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 map[string]interface{} `json:"extra"`
	Name  string                 `json:"name"`
	Uri   string                 `json:"uri"`
}

AssetReferenceAssetEventDagRun Schema for AssetModel used in AssetEventDagRunReference.

type AssetResponse

type AssetResponse struct {
	Extra *map[string]interface{} `json:"extra"`
	Group string                  `json:"group"`
	Name  string                  `json:"name"`
	Uri   string                  `json:"uri"`
}

AssetResponse Asset schema for responses with fields that are needed for Runtime.

type AssetsClient

type AssetsClient interface {
	// Get an Airflow Asset by `name`.
	GetByName(ctx context.Context, params *GetAssetByNameParams) (*AssetResponse, error)
	// GetByNameResponse is a lower level version of [GetByName] and provides access to the raw [resty.Response]
	GetByNameResponse(ctx context.Context, params *GetAssetByNameParams) (*resty.Response, error)

	// Get an Airflow Asset by `uri`.
	GetByUri(ctx context.Context, params *GetAssetByUriParams) (*AssetResponse, error)
	// GetByUriResponse is a lower level version of [GetByUri] and provides access to the raw [resty.Response]
	GetByUriResponse(ctx context.Context, params *GetAssetByUriParams) (*resty.Response, error)
}

type BundleInfo

type BundleInfo struct {
	Name    string  `json:"name"`
	Version *string `json:"version"`
}

BundleInfo Schema for telling task which bundle to run with.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	*resty.Client

	RequestMiddleware []resty.RequestMiddleware
}

Client which conforms to the OpenAPI3 specification for this service.

func (*Client) AssetEvents

func (c *Client) AssetEvents() AssetEventsClient

func (*Client) Assets

func (c *Client) Assets() AssetsClient

func (*Client) Connections

func (c *Client) Connections() ConnectionsClient

func (*Client) DagRuns

func (c *Client) DagRuns() DagRunsClient

func (*Client) TaskInstances

func (c *Client) TaskInstances() TaskInstancesClient

func (*Client) TaskReschedules

func (c *Client) TaskReschedules() TaskReschedulesClient

func (*Client) Variables

func (c *Client) Variables() VariablesClient

func (*Client) WithBearerToken

func (c *Client) WithBearerToken(token string) (ClientInterface, error)

WithBearerToken creates a copy of the client (reusing the underlying http.Client) adding in a Bearer token auth to all requests

func (*Client) Xcoms

func (c *Client) Xcoms() XcomsClient

type ClientInterface

type ClientInterface interface {
	// AssetEvents deals with all the Asset Events endpoints
	AssetEvents() AssetEventsClient
	// Assets deals with all the Assets endpoints
	Assets() AssetsClient
	// Connections deals with all the Connections endpoints
	Connections() ConnectionsClient
	// DagRuns deals with all the Dag Runs endpoints
	DagRuns() DagRunsClient
	// TaskInstances deals with all the Task Instances endpoints
	TaskInstances() TaskInstancesClient
	// TaskReschedules deals with all the Task Reschedules endpoints
	TaskReschedules() TaskReschedulesClient
	// Variables deals with all the Variables endpoints
	Variables() VariablesClient
	// Xcoms deals with all the XComs endpoints
	Xcoms() XcomsClient
}

func NewClient

func NewClient(server string, opts ...ClientOption) (ClientInterface, error)

func NewDefaultClient

func NewDefaultClient(server string, opts ...ClientOption) (ClientInterface, error)

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithClient

func WithClient(r *resty.Client) ClientOption

WithClient allows overriding the default resty.Client, which is automatically created using http.Client.

If this is used the `server` base URL argument passed in will not be respected anymore

func WithRequestMiddleware

func WithRequestMiddleware(mw resty.RequestMiddleware) ClientOption

WithRequestMiddleware allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithRoundTripper

func WithRoundTripper(transport http.RoundTripper) ClientOption

WithRoundTripper method sets custom http.Transport or any http.RoundTripper compatible interface implementation in the Resty client

type ConnectionResponse

type ConnectionResponse struct {
	ConnId   string  `json:"conn_id"`
	ConnType string  `json:"conn_type"`
	Extra    *string `json:"extra"`
	Host     *string `json:"host"`
	Login    *string `json:"login"`
	Password *string `json:"password"`
	Port     *int    `json:"port"`
	Schema   *string `json:"schema"`
}

ConnectionResponse Connection schema for responses with fields that are needed for Runtime.

type ConnectionsClient

type ConnectionsClient interface {
	// Get an Airflow connection.
	Get(ctx context.Context, connectionId string) (*ConnectionResponse, error)
	// GetResponse is a lower level version of [Get] and provides access to the raw [resty.Response]
	GetResponse(ctx context.Context, connectionId string) (*resty.Response, error)
}

type DagRun

type DagRun struct {
	ClearNumber         *int                        `json:"clear_number,omitempty"`
	Conf                *map[string]interface{}     `json:"conf,omitempty"`
	ConsumedAssetEvents []AssetEventDagRunReference `json:"consumed_asset_events"`
	DagId               string                      `json:"dag_id"`
	DataIntervalEnd     *time.Time                  `json:"data_interval_end"`
	DataIntervalStart   *time.Time                  `json:"data_interval_start"`
	EndDate             *time.Time                  `json:"end_date"`
	LogicalDate         *time.Time                  `json:"logical_date"`
	RunAfter            time.Time                   `json:"run_after"`
	RunId               string                      `json:"run_id"`

	// RunType Class with DagRun types.
	RunType   DagRunType `json:"run_type"`
	StartDate time.Time  `json:"start_date"`
}

DagRun Schema for DagRun model with minimal required fields needed for Runtime.

type DagRunAssetReference

type DagRunAssetReference struct {
	DagId             string     `json:"dag_id"`
	DataIntervalEnd   *time.Time `json:"data_interval_end"`
	DataIntervalStart *time.Time `json:"data_interval_start"`
	EndDate           *time.Time `json:"end_date"`
	LogicalDate       *time.Time `json:"logical_date"`
	RunId             string     `json:"run_id"`
	StartDate         time.Time  `json:"start_date"`
	State             string     `json:"state"`
}

DagRunAssetReference DagRun serializer for asset responses.

type DagRunState

type DagRunState string

DagRunState 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.

const (
	DagRunStateFailed  DagRunState = "failed"
	DagRunStateQueued  DagRunState = "queued"
	DagRunStateRunning DagRunState = "running"
	DagRunStateSuccess DagRunState = "success"
)

Defines values for DagRunState.

type DagRunStateResponse

type DagRunStateResponse struct {
	// State 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.
	State DagRunState `json:"state"`
}

DagRunStateResponse Schema for DAG Run State response.

type DagRunType

type DagRunType string

DagRunType Class with DagRun types.

const (
	DagRunTypeAssetTriggered DagRunType = "asset_triggered"
	DagRunTypeBackfill       DagRunType = "backfill"
	DagRunTypeManual         DagRunType = "manual"
	DagRunTypeScheduled      DagRunType = "scheduled"
)

Defines values for DagRunType.

type DagRunsClient

type DagRunsClient interface {
	// Get the count of DAG runs matching the given criteria.
	GetDrCount(ctx context.Context, params *GetDrCountParams) (*int, error)
	// GetDrCountResponse is a lower level version of [GetDrCount] and provides access to the raw [resty.Response]
	GetDrCountResponse(ctx context.Context, params *GetDrCountParams) (*resty.Response, error)

	// Trigger a DAG Run.
	Trigger(ctx context.Context, dagId string, runId string, body *TriggerDAGRunPayload) error
	// TriggerResponse is a lower level version of [Trigger] and provides access to the raw [resty.Response]
	TriggerResponse(ctx context.Context, dagId string, runId string, body *TriggerDAGRunPayload) (*resty.Response, error)

	// Clear a DAG Run.
	Clear(ctx context.Context, dagId string, runId string) error
	// ClearResponse is a lower level version of [Clear] and provides access to the raw [resty.Response]
	ClearResponse(ctx context.Context, dagId string, runId string) (*resty.Response, error)

	// Get a DAG Run State.
	GetState(ctx context.Context, dagId string, runId string) (*DagRunStateResponse, error)
	// GetStateResponse is a lower level version of [GetState] and provides access to the raw [resty.Response]
	GetStateResponse(ctx context.Context, dagId string, runId string) (*resty.Response, error)
}

type DeleteXcomParams

type DeleteXcomParams struct {
	MapIndex *int `form:"map_index,omitempty" json:"map_index,omitempty"`
}

DeleteXcomParams defines parameters for DeleteXcom.

type ExecuteTaskWorkload

type ExecuteTaskWorkload struct {
	Token      string       `json:"token"`
	TI         TaskInstance `json:"ti"`
	BundleInfo BundleInfo   `json:"bundle_info"`
	LogPath    *string      `json:"log_path,omitempty"`
}

type GeneralHTTPError

type GeneralHTTPError struct {
	Response *resty.Response
	JSON     map[string]any
	Text     string
}

func (GeneralHTTPError) Error

func (e GeneralHTTPError) Error() string

type GetAssetByNameParams

type GetAssetByNameParams struct {
	// Name The name of the Asset
	Name string `form:"name" json:"name"`
}

GetAssetByNameParams defines parameters for GetAssetByName.

type GetAssetByUriParams

type GetAssetByUriParams struct {
	// Uri The URI of the Asset
	Uri string `form:"uri" json:"uri"`
}

GetAssetByUriParams defines parameters for GetAssetByUri.

type GetAssetEventByAssetAliasParams

type GetAssetEventByAssetAliasParams struct {
	// Name The name of the Asset Alias
	Name string `form:"name" json:"name"`
}

GetAssetEventByAssetAliasParams defines parameters for GetAssetEventByAssetAlias.

type GetAssetEventByAssetNameUriParams

type GetAssetEventByAssetNameUriParams struct {
	// Name The name of the Asset
	Name string `form:"name" json:"name"`

	// Uri The URI of the Asset
	Uri string `form:"uri" json:"uri"`
}

GetAssetEventByAssetNameUriParams defines parameters for GetAssetEventByAssetNameUri.

type GetDrCountParams

type GetDrCountParams struct {
	DagId        string       `form:"dag_id" json:"dag_id"`
	LogicalDates *[]time.Time `form:"logical_dates,omitempty" json:"logical_dates,omitempty"`
	RunIds       *[]string    `form:"run_ids,omitempty" json:"run_ids,omitempty"`
	States       *[]string    `form:"states,omitempty" json:"states,omitempty"`
}

GetDrCountParams defines parameters for GetDrCount.

type GetMappedXcomBySliceParams

type GetMappedXcomBySliceParams struct {
	Start *int `form:"start,omitempty" json:"start,omitempty"`
	Stop  *int `form:"stop,omitempty" json:"stop,omitempty"`
	Step  *int `form:"step,omitempty" json:"step,omitempty"`
}

GetMappedXcomBySliceParams defines parameters for GetMappedXcomBySlice.

type GetTaskInstanceCountParams

type GetTaskInstanceCountParams struct {
	DagId        string       `form:"dag_id" json:"dag_id"`
	MapIndex     *int         `form:"map_index,omitempty" json:"map_index,omitempty"`
	TaskIds      *[]string    `form:"task_ids,omitempty" json:"task_ids,omitempty"`
	TaskGroupId  *string      `form:"task_group_id,omitempty" json:"task_group_id,omitempty"`
	LogicalDates *[]time.Time `form:"logical_dates,omitempty" json:"logical_dates,omitempty"`
	RunIds       *[]string    `form:"run_ids,omitempty" json:"run_ids,omitempty"`
	States       *[]string    `form:"states,omitempty" json:"states,omitempty"`
}

GetTaskInstanceCountParams defines parameters for GetTaskInstanceCount.

type GetTaskInstanceStatesParams

type GetTaskInstanceStatesParams struct {
	DagId        string       `form:"dag_id" json:"dag_id"`
	MapIndex     *int         `form:"map_index,omitempty" json:"map_index,omitempty"`
	TaskIds      *[]string    `form:"task_ids,omitempty" json:"task_ids,omitempty"`
	TaskGroupId  *string      `form:"task_group_id,omitempty" json:"task_group_id,omitempty"`
	LogicalDates *[]time.Time `form:"logical_dates,omitempty" json:"logical_dates,omitempty"`
	RunIds       *[]string    `form:"run_ids,omitempty" json:"run_ids,omitempty"`
}

GetTaskInstanceStatesParams defines parameters for GetTaskInstanceStates.

type GetXcomParams

type GetXcomParams struct {
	MapIndex          *int  `form:"map_index,omitempty" json:"map_index,omitempty"`
	IncludePriorDates *bool `form:"include_prior_dates,omitempty" json:"include_prior_dates,omitempty"`
	Offset            *int  `form:"offset,omitempty" json:"offset,omitempty"`
}

GetXcomParams defines parameters for GetXcom.

type HTTPValidationError

type HTTPValidationError struct {
	Detail *[]ValidationError `json:"detail,omitempty"`
}

HTTPValidationError defines model for HTTPValidationError.

type HeadXcomParams

type HeadXcomParams struct {
	MapIndex *int `form:"map_index,omitempty" json:"map_index,omitempty"`
}

HeadXcomParams defines parameters for HeadXcom.

type InactiveAssetsResponse

type InactiveAssetsResponse struct {
	InactiveAssets *[]AssetProfile `json:"inactive_assets,omitempty"`
}

InactiveAssetsResponse Response for inactive assets.

type IntermediateTIState

type IntermediateTIState string

IntermediateTIState States that a Task Instance can be in that indicate it is not yet in a terminal or running state.

const (
	IntermediateTIStateDeferred        IntermediateTIState = "deferred"
	IntermediateTIStateQueued          IntermediateTIState = "queued"
	IntermediateTIStateRestarting      IntermediateTIState = "restarting"
	IntermediateTIStateScheduled       IntermediateTIState = "scheduled"
	IntermediateTIStateUpForReschedule IntermediateTIState = "up_for_reschedule"
	IntermediateTIStateUpForRetry      IntermediateTIState = "up_for_retry"
	IntermediateTIStateUpstreamFailed  IntermediateTIState = "upstream_failed"
)

Defines values for IntermediateTIState.

type JsonValue

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

JsonValue defines model for JsonValue.

func (JsonValue) AsJsonValue0

func (t JsonValue) AsJsonValue0() (JsonValue0, error)

AsJsonValue0 returns the union data inside the JsonValue as a JsonValue0

func (JsonValue) AsJsonValue1

func (t JsonValue) AsJsonValue1() (JsonValue1, error)

AsJsonValue1 returns the union data inside the JsonValue as a JsonValue1

func (JsonValue) AsJsonValue2

func (t JsonValue) AsJsonValue2() (JsonValue2, error)

AsJsonValue2 returns the union data inside the JsonValue as a JsonValue2

func (JsonValue) AsJsonValue3

func (t JsonValue) AsJsonValue3() (JsonValue3, error)

AsJsonValue3 returns the union data inside the JsonValue as a JsonValue3

func (JsonValue) AsJsonValue4

func (t JsonValue) AsJsonValue4() (JsonValue4, error)

AsJsonValue4 returns the union data inside the JsonValue as a JsonValue4

func (JsonValue) AsJsonValue5

func (t JsonValue) AsJsonValue5() (JsonValue5, error)

AsJsonValue5 returns the union data inside the JsonValue as a JsonValue5

func (*JsonValue) FromJsonValue0

func (t *JsonValue) FromJsonValue0(v JsonValue0) error

FromJsonValue0 overwrites any union data inside the JsonValue as the provided JsonValue0

func (*JsonValue) FromJsonValue1

func (t *JsonValue) FromJsonValue1(v JsonValue1) error

FromJsonValue1 overwrites any union data inside the JsonValue as the provided JsonValue1

func (*JsonValue) FromJsonValue2

func (t *JsonValue) FromJsonValue2(v JsonValue2) error

FromJsonValue2 overwrites any union data inside the JsonValue as the provided JsonValue2

func (*JsonValue) FromJsonValue3

func (t *JsonValue) FromJsonValue3(v JsonValue3) error

FromJsonValue3 overwrites any union data inside the JsonValue as the provided JsonValue3

func (*JsonValue) FromJsonValue4

func (t *JsonValue) FromJsonValue4(v JsonValue4) error

FromJsonValue4 overwrites any union data inside the JsonValue as the provided JsonValue4

func (*JsonValue) FromJsonValue5

func (t *JsonValue) FromJsonValue5(v JsonValue5) error

FromJsonValue5 overwrites any union data inside the JsonValue as the provided JsonValue5

func (JsonValue) MarshalJSON

func (t JsonValue) MarshalJSON() ([]byte, error)

func (*JsonValue) MergeJsonValue0

func (t *JsonValue) MergeJsonValue0(v JsonValue0) error

MergeJsonValue0 performs a merge with any union data inside the JsonValue, using the provided JsonValue0

func (*JsonValue) MergeJsonValue1

func (t *JsonValue) MergeJsonValue1(v JsonValue1) error

MergeJsonValue1 performs a merge with any union data inside the JsonValue, using the provided JsonValue1

func (*JsonValue) MergeJsonValue2

func (t *JsonValue) MergeJsonValue2(v JsonValue2) error

MergeJsonValue2 performs a merge with any union data inside the JsonValue, using the provided JsonValue2

func (*JsonValue) MergeJsonValue3

func (t *JsonValue) MergeJsonValue3(v JsonValue3) error

MergeJsonValue3 performs a merge with any union data inside the JsonValue, using the provided JsonValue3

func (*JsonValue) MergeJsonValue4

func (t *JsonValue) MergeJsonValue4(v JsonValue4) error

MergeJsonValue4 performs a merge with any union data inside the JsonValue, using the provided JsonValue4

func (*JsonValue) MergeJsonValue5

func (t *JsonValue) MergeJsonValue5(v JsonValue5) error

MergeJsonValue5 performs a merge with any union data inside the JsonValue, using the provided JsonValue5

func (*JsonValue) UnmarshalJSON

func (t *JsonValue) UnmarshalJSON(b []byte) error

type JsonValue0

type JsonValue0 = string

JsonValue0 defines model for .

type JsonValue1

type JsonValue1 = float32

JsonValue1 defines model for .

type JsonValue2

type JsonValue2 = int

JsonValue2 defines model for .

type JsonValue3

type JsonValue3 = map[string]interface{}

JsonValue3 defines model for .

type JsonValue4

type JsonValue4 = []interface{}

JsonValue4 defines model for .

type JsonValue5

type JsonValue5 = bool

JsonValue5 defines model for .

type PrevSuccessfulDagRunResponse

type PrevSuccessfulDagRunResponse struct {
	DataIntervalEnd   *time.Time `json:"data_interval_end"`
	DataIntervalStart *time.Time `json:"data_interval_start"`
	EndDate           *time.Time `json:"end_date"`
	StartDate         *time.Time `json:"start_date"`
}

PrevSuccessfulDagRunResponse Schema for response with previous successful DagRun information for Task Template Context.

type PutVariableJSONRequestBody

type PutVariableJSONRequestBody = VariablePostBody

PutVariableJSONRequestBody defines body for PutVariable for application/json ContentType.

type SetXcomJSONBody

type SetXcomJSONBody = interface{}

SetXcomJSONBody defines parameters for SetXcom.

type SetXcomJSONRequestBody

type SetXcomJSONRequestBody = SetXcomJSONBody

SetXcomJSONRequestBody defines body for SetXcom for application/json ContentType.

type SetXcomParams

type SetXcomParams struct {
	MapIndex *int `form:"map_index,omitempty" json:"map_index,omitempty"`

	// MappedLength Number of mapped tasks this value expands into
	MappedLength *int `form:"mapped_length,omitempty" json:"mapped_length,omitempty"`
}

SetXcomParams defines parameters for SetXcom.

type TIDeferredStatePayload

type TIDeferredStatePayload struct {
	Classpath        string                                `json:"classpath"`
	NextKwargs       *TIDeferredStatePayload_NextKwargs    `json:"next_kwargs,omitempty"`
	NextMethod       string                                `json:"next_method"`
	RenderedMapIndex *string                               `json:"rendered_map_index"`
	State            TIDeferredStatePayloadState           `json:"state"`
	TriggerKwargs    *TIDeferredStatePayload_TriggerKwargs `json:"trigger_kwargs,omitempty"`
	TriggerTimeout   *string                               `json:"trigger_timeout"`
}

TIDeferredStatePayload Schema for updating TaskInstance to a deferred state.

type TIDeferredStatePayloadNextKwargs0

type TIDeferredStatePayloadNextKwargs0 map[string]interface{}

TIDeferredStatePayloadNextKwargs0 defines model for .

type TIDeferredStatePayloadNextKwargs1

type TIDeferredStatePayloadNextKwargs1 = string

TIDeferredStatePayloadNextKwargs1 defines model for .

type TIDeferredStatePayloadState

type TIDeferredStatePayloadState string

TIDeferredStatePayloadState defines model for TIDeferredStatePayload.State.

const (
	Deferred TIDeferredStatePayloadState = "deferred"
)

Defines values for TIDeferredStatePayloadState.

type TIDeferredStatePayloadTriggerKwargs0

type TIDeferredStatePayloadTriggerKwargs0 map[string]interface{}

TIDeferredStatePayloadTriggerKwargs0 defines model for .

type TIDeferredStatePayloadTriggerKwargs1

type TIDeferredStatePayloadTriggerKwargs1 = string

TIDeferredStatePayloadTriggerKwargs1 defines model for .

type TIDeferredStatePayload_NextKwargs

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

TIDeferredStatePayload_NextKwargs defines model for TIDeferredStatePayload.NextKwargs.

func (TIDeferredStatePayload_NextKwargs) AsTIDeferredStatePayloadNextKwargs0

func (t TIDeferredStatePayload_NextKwargs) AsTIDeferredStatePayloadNextKwargs0() (TIDeferredStatePayloadNextKwargs0, error)

AsTIDeferredStatePayloadNextKwargs0 returns the union data inside the TIDeferredStatePayload_NextKwargs as a TIDeferredStatePayloadNextKwargs0

func (TIDeferredStatePayload_NextKwargs) AsTIDeferredStatePayloadNextKwargs1

func (t TIDeferredStatePayload_NextKwargs) AsTIDeferredStatePayloadNextKwargs1() (TIDeferredStatePayloadNextKwargs1, error)

AsTIDeferredStatePayloadNextKwargs1 returns the union data inside the TIDeferredStatePayload_NextKwargs as a TIDeferredStatePayloadNextKwargs1

func (*TIDeferredStatePayload_NextKwargs) FromTIDeferredStatePayloadNextKwargs0

func (t *TIDeferredStatePayload_NextKwargs) FromTIDeferredStatePayloadNextKwargs0(v TIDeferredStatePayloadNextKwargs0) error

FromTIDeferredStatePayloadNextKwargs0 overwrites any union data inside the TIDeferredStatePayload_NextKwargs as the provided TIDeferredStatePayloadNextKwargs0

func (*TIDeferredStatePayload_NextKwargs) FromTIDeferredStatePayloadNextKwargs1

func (t *TIDeferredStatePayload_NextKwargs) FromTIDeferredStatePayloadNextKwargs1(v TIDeferredStatePayloadNextKwargs1) error

FromTIDeferredStatePayloadNextKwargs1 overwrites any union data inside the TIDeferredStatePayload_NextKwargs as the provided TIDeferredStatePayloadNextKwargs1

func (TIDeferredStatePayload_NextKwargs) MarshalJSON

func (t TIDeferredStatePayload_NextKwargs) MarshalJSON() ([]byte, error)

func (*TIDeferredStatePayload_NextKwargs) MergeTIDeferredStatePayloadNextKwargs0

func (t *TIDeferredStatePayload_NextKwargs) MergeTIDeferredStatePayloadNextKwargs0(v TIDeferredStatePayloadNextKwargs0) error

MergeTIDeferredStatePayloadNextKwargs0 performs a merge with any union data inside the TIDeferredStatePayload_NextKwargs, using the provided TIDeferredStatePayloadNextKwargs0

func (*TIDeferredStatePayload_NextKwargs) MergeTIDeferredStatePayloadNextKwargs1

func (t *TIDeferredStatePayload_NextKwargs) MergeTIDeferredStatePayloadNextKwargs1(v TIDeferredStatePayloadNextKwargs1) error

MergeTIDeferredStatePayloadNextKwargs1 performs a merge with any union data inside the TIDeferredStatePayload_NextKwargs, using the provided TIDeferredStatePayloadNextKwargs1

func (*TIDeferredStatePayload_NextKwargs) UnmarshalJSON

func (t *TIDeferredStatePayload_NextKwargs) UnmarshalJSON(b []byte) error

type TIDeferredStatePayload_TriggerKwargs

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

TIDeferredStatePayload_TriggerKwargs defines model for TIDeferredStatePayload.TriggerKwargs.

func (TIDeferredStatePayload_TriggerKwargs) AsTIDeferredStatePayloadTriggerKwargs0

func (t TIDeferredStatePayload_TriggerKwargs) AsTIDeferredStatePayloadTriggerKwargs0() (TIDeferredStatePayloadTriggerKwargs0, error)

AsTIDeferredStatePayloadTriggerKwargs0 returns the union data inside the TIDeferredStatePayload_TriggerKwargs as a TIDeferredStatePayloadTriggerKwargs0

func (TIDeferredStatePayload_TriggerKwargs) AsTIDeferredStatePayloadTriggerKwargs1

func (t TIDeferredStatePayload_TriggerKwargs) AsTIDeferredStatePayloadTriggerKwargs1() (TIDeferredStatePayloadTriggerKwargs1, error)

AsTIDeferredStatePayloadTriggerKwargs1 returns the union data inside the TIDeferredStatePayload_TriggerKwargs as a TIDeferredStatePayloadTriggerKwargs1

func (*TIDeferredStatePayload_TriggerKwargs) FromTIDeferredStatePayloadTriggerKwargs0

func (t *TIDeferredStatePayload_TriggerKwargs) FromTIDeferredStatePayloadTriggerKwargs0(v TIDeferredStatePayloadTriggerKwargs0) error

FromTIDeferredStatePayloadTriggerKwargs0 overwrites any union data inside the TIDeferredStatePayload_TriggerKwargs as the provided TIDeferredStatePayloadTriggerKwargs0

func (*TIDeferredStatePayload_TriggerKwargs) FromTIDeferredStatePayloadTriggerKwargs1

func (t *TIDeferredStatePayload_TriggerKwargs) FromTIDeferredStatePayloadTriggerKwargs1(v TIDeferredStatePayloadTriggerKwargs1) error

FromTIDeferredStatePayloadTriggerKwargs1 overwrites any union data inside the TIDeferredStatePayload_TriggerKwargs as the provided TIDeferredStatePayloadTriggerKwargs1

func (TIDeferredStatePayload_TriggerKwargs) MarshalJSON

func (t TIDeferredStatePayload_TriggerKwargs) MarshalJSON() ([]byte, error)

func (*TIDeferredStatePayload_TriggerKwargs) MergeTIDeferredStatePayloadTriggerKwargs0

func (t *TIDeferredStatePayload_TriggerKwargs) MergeTIDeferredStatePayloadTriggerKwargs0(v TIDeferredStatePayloadTriggerKwargs0) error

MergeTIDeferredStatePayloadTriggerKwargs0 performs a merge with any union data inside the TIDeferredStatePayload_TriggerKwargs, using the provided TIDeferredStatePayloadTriggerKwargs0

func (*TIDeferredStatePayload_TriggerKwargs) MergeTIDeferredStatePayloadTriggerKwargs1

func (t *TIDeferredStatePayload_TriggerKwargs) MergeTIDeferredStatePayloadTriggerKwargs1(v TIDeferredStatePayloadTriggerKwargs1) error

MergeTIDeferredStatePayloadTriggerKwargs1 performs a merge with any union data inside the TIDeferredStatePayload_TriggerKwargs, using the provided TIDeferredStatePayloadTriggerKwargs1

func (*TIDeferredStatePayload_TriggerKwargs) UnmarshalJSON

func (t *TIDeferredStatePayload_TriggerKwargs) UnmarshalJSON(b []byte) error

type TIEnterRunningPayload

type TIEnterRunningPayload struct {
	Hostname  string                     `json:"hostname"`
	Pid       int                        `json:"pid"`
	StartDate time.Time                  `json:"start_date"`
	State     TIEnterRunningPayloadState `json:"state"`
	Unixname  string                     `json:"unixname"`
}

TIEnterRunningPayload Schema for updating TaskInstance to 'RUNNING' state with minimal required fields.

type TIEnterRunningPayloadState

type TIEnterRunningPayloadState string

TIEnterRunningPayloadState defines model for TIEnterRunningPayload.State.

const (
	Running TIEnterRunningPayloadState = "running"
)

Defines values for TIEnterRunningPayloadState.

type TIHeartbeatInfo

type TIHeartbeatInfo struct {
	Hostname string `json:"hostname"`
	Pid      int    `json:"pid"`
}

TIHeartbeatInfo Schema for TaskInstance heartbeat endpoint.

type TIRescheduleStatePayload

type TIRescheduleStatePayload struct {
	EndDate        time.Time                     `json:"end_date"`
	RescheduleDate time.Time                     `json:"reschedule_date"`
	State          TIRescheduleStatePayloadState `json:"state"`
}

TIRescheduleStatePayload Schema for updating TaskInstance to a up_for_reschedule state.

type TIRescheduleStatePayloadState

type TIRescheduleStatePayloadState string

TIRescheduleStatePayloadState defines model for TIRescheduleStatePayload.State.

const (
	UpForReschedule TIRescheduleStatePayloadState = "up_for_reschedule"
)

Defines values for TIRescheduleStatePayloadState.

type TIRetryStatePayload

type TIRetryStatePayload struct {
	EndDate          time.Time                `json:"end_date"`
	RenderedMapIndex *string                  `json:"rendered_map_index"`
	State            TIRetryStatePayloadState `json:"state"`
}

TIRetryStatePayload Schema for updating TaskInstance to up_for_retry.

type TIRetryStatePayloadState

type TIRetryStatePayloadState string

TIRetryStatePayloadState defines model for TIRetryStatePayload.State.

const (
	UpForRetry TIRetryStatePayloadState = "up_for_retry"
)

Defines values for TIRetryStatePayloadState.

type TIRunContext

type TIRunContext struct {
	Connections *[]ConnectionResponse `json:"connections,omitempty"`

	// DagRun Schema for DagRun model with minimal required fields needed for Runtime.
	DagRun              DagRun                                                            `json:"dag_run"`
	MaxTries            int                                                               `json:"max_tries"`
	NextKwargs          *TIRunContext_NextKwargs                                          `json:"next_kwargs"`
	NextMethod          *string                                                           `json:"next_method"`
	ShouldRetry         *bool                                                             `json:"should_retry,omitempty"`
	TaskRescheduleCount *int                                                              `json:"task_reschedule_count,omitempty"`
	UpstreamMapIndexes  *map[string]*TIRunContext_UpstreamMapIndexes_AdditionalProperties `json:"upstream_map_indexes"`
	Variables           *[]VariableResponse                                               `json:"variables,omitempty"`
	XcomKeysToClear     *[]string                                                         `json:"xcom_keys_to_clear,omitempty"`
}

TIRunContext Response schema for TaskInstance run context.

type TIRunContextNextKwargs0

type TIRunContextNextKwargs0 map[string]interface{}

TIRunContextNextKwargs0 defines model for .

type TIRunContextNextKwargs1

type TIRunContextNextKwargs1 = string

TIRunContextNextKwargs1 defines model for .

type TIRunContextUpstreamMapIndexes0

type TIRunContextUpstreamMapIndexes0 = int

TIRunContextUpstreamMapIndexes0 defines model for .

type TIRunContextUpstreamMapIndexes1

type TIRunContextUpstreamMapIndexes1 = []int

TIRunContextUpstreamMapIndexes1 defines model for .

type TIRunContext_NextKwargs

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

TIRunContext_NextKwargs defines model for TIRunContext.NextKwargs.

func (TIRunContext_NextKwargs) AsTIRunContextNextKwargs0

func (t TIRunContext_NextKwargs) AsTIRunContextNextKwargs0() (TIRunContextNextKwargs0, error)

AsTIRunContextNextKwargs0 returns the union data inside the TIRunContext_NextKwargs as a TIRunContextNextKwargs0

func (TIRunContext_NextKwargs) AsTIRunContextNextKwargs1

func (t TIRunContext_NextKwargs) AsTIRunContextNextKwargs1() (TIRunContextNextKwargs1, error)

AsTIRunContextNextKwargs1 returns the union data inside the TIRunContext_NextKwargs as a TIRunContextNextKwargs1

func (*TIRunContext_NextKwargs) FromTIRunContextNextKwargs0

func (t *TIRunContext_NextKwargs) FromTIRunContextNextKwargs0(v TIRunContextNextKwargs0) error

FromTIRunContextNextKwargs0 overwrites any union data inside the TIRunContext_NextKwargs as the provided TIRunContextNextKwargs0

func (*TIRunContext_NextKwargs) FromTIRunContextNextKwargs1

func (t *TIRunContext_NextKwargs) FromTIRunContextNextKwargs1(v TIRunContextNextKwargs1) error

FromTIRunContextNextKwargs1 overwrites any union data inside the TIRunContext_NextKwargs as the provided TIRunContextNextKwargs1

func (TIRunContext_NextKwargs) MarshalJSON

func (t TIRunContext_NextKwargs) MarshalJSON() ([]byte, error)

func (*TIRunContext_NextKwargs) MergeTIRunContextNextKwargs0

func (t *TIRunContext_NextKwargs) MergeTIRunContextNextKwargs0(v TIRunContextNextKwargs0) error

MergeTIRunContextNextKwargs0 performs a merge with any union data inside the TIRunContext_NextKwargs, using the provided TIRunContextNextKwargs0

func (*TIRunContext_NextKwargs) MergeTIRunContextNextKwargs1

func (t *TIRunContext_NextKwargs) MergeTIRunContextNextKwargs1(v TIRunContextNextKwargs1) error

MergeTIRunContextNextKwargs1 performs a merge with any union data inside the TIRunContext_NextKwargs, using the provided TIRunContextNextKwargs1

func (*TIRunContext_NextKwargs) UnmarshalJSON

func (t *TIRunContext_NextKwargs) UnmarshalJSON(b []byte) error

type TIRunContext_UpstreamMapIndexes_AdditionalProperties

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

TIRunContext_UpstreamMapIndexes_AdditionalProperties defines model for TIRunContext.upstream_map_indexes.AdditionalProperties.

func (TIRunContext_UpstreamMapIndexes_AdditionalProperties) AsTIRunContextUpstreamMapIndexes0

AsTIRunContextUpstreamMapIndexes0 returns the union data inside the TIRunContext_UpstreamMapIndexes_AdditionalProperties as a TIRunContextUpstreamMapIndexes0

func (TIRunContext_UpstreamMapIndexes_AdditionalProperties) AsTIRunContextUpstreamMapIndexes1

AsTIRunContextUpstreamMapIndexes1 returns the union data inside the TIRunContext_UpstreamMapIndexes_AdditionalProperties as a TIRunContextUpstreamMapIndexes1

func (*TIRunContext_UpstreamMapIndexes_AdditionalProperties) FromTIRunContextUpstreamMapIndexes0

FromTIRunContextUpstreamMapIndexes0 overwrites any union data inside the TIRunContext_UpstreamMapIndexes_AdditionalProperties as the provided TIRunContextUpstreamMapIndexes0

func (*TIRunContext_UpstreamMapIndexes_AdditionalProperties) FromTIRunContextUpstreamMapIndexes1

FromTIRunContextUpstreamMapIndexes1 overwrites any union data inside the TIRunContext_UpstreamMapIndexes_AdditionalProperties as the provided TIRunContextUpstreamMapIndexes1

func (TIRunContext_UpstreamMapIndexes_AdditionalProperties) MarshalJSON

func (*TIRunContext_UpstreamMapIndexes_AdditionalProperties) MergeTIRunContextUpstreamMapIndexes0

MergeTIRunContextUpstreamMapIndexes0 performs a merge with any union data inside the TIRunContext_UpstreamMapIndexes_AdditionalProperties, using the provided TIRunContextUpstreamMapIndexes0

func (*TIRunContext_UpstreamMapIndexes_AdditionalProperties) MergeTIRunContextUpstreamMapIndexes1

MergeTIRunContextUpstreamMapIndexes1 performs a merge with any union data inside the TIRunContext_UpstreamMapIndexes_AdditionalProperties, using the provided TIRunContextUpstreamMapIndexes1

func (*TIRunContext_UpstreamMapIndexes_AdditionalProperties) UnmarshalJSON

type TISkippedDownstreamTasksStatePayload

type TISkippedDownstreamTasksStatePayload struct {
	Tasks []TISkippedDownstreamTasksStatePayload_Tasks_Item `json:"tasks"`
}

TISkippedDownstreamTasksStatePayload Schema for updating downstream tasks to a skipped state.

type TISkippedDownstreamTasksStatePayloadTasks0

type TISkippedDownstreamTasksStatePayloadTasks0 = string

TISkippedDownstreamTasksStatePayloadTasks0 defines model for .

type TISkippedDownstreamTasksStatePayloadTasks1

type TISkippedDownstreamTasksStatePayloadTasks1 = []interface{}

TISkippedDownstreamTasksStatePayloadTasks1 defines model for .

type TISkippedDownstreamTasksStatePayload_Tasks_Item

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

TISkippedDownstreamTasksStatePayload_Tasks_Item defines model for TISkippedDownstreamTasksStatePayload.tasks.Item.

func (TISkippedDownstreamTasksStatePayload_Tasks_Item) AsTISkippedDownstreamTasksStatePayloadTasks0

func (t TISkippedDownstreamTasksStatePayload_Tasks_Item) AsTISkippedDownstreamTasksStatePayloadTasks0() (TISkippedDownstreamTasksStatePayloadTasks0, error)

AsTISkippedDownstreamTasksStatePayloadTasks0 returns the union data inside the TISkippedDownstreamTasksStatePayload_Tasks_Item as a TISkippedDownstreamTasksStatePayloadTasks0

func (TISkippedDownstreamTasksStatePayload_Tasks_Item) AsTISkippedDownstreamTasksStatePayloadTasks1

func (t TISkippedDownstreamTasksStatePayload_Tasks_Item) AsTISkippedDownstreamTasksStatePayloadTasks1() (TISkippedDownstreamTasksStatePayloadTasks1, error)

AsTISkippedDownstreamTasksStatePayloadTasks1 returns the union data inside the TISkippedDownstreamTasksStatePayload_Tasks_Item as a TISkippedDownstreamTasksStatePayloadTasks1

func (*TISkippedDownstreamTasksStatePayload_Tasks_Item) FromTISkippedDownstreamTasksStatePayloadTasks0

func (t *TISkippedDownstreamTasksStatePayload_Tasks_Item) FromTISkippedDownstreamTasksStatePayloadTasks0(v TISkippedDownstreamTasksStatePayloadTasks0) error

FromTISkippedDownstreamTasksStatePayloadTasks0 overwrites any union data inside the TISkippedDownstreamTasksStatePayload_Tasks_Item as the provided TISkippedDownstreamTasksStatePayloadTasks0

func (*TISkippedDownstreamTasksStatePayload_Tasks_Item) FromTISkippedDownstreamTasksStatePayloadTasks1

func (t *TISkippedDownstreamTasksStatePayload_Tasks_Item) FromTISkippedDownstreamTasksStatePayloadTasks1(v TISkippedDownstreamTasksStatePayloadTasks1) error

FromTISkippedDownstreamTasksStatePayloadTasks1 overwrites any union data inside the TISkippedDownstreamTasksStatePayload_Tasks_Item as the provided TISkippedDownstreamTasksStatePayloadTasks1

func (TISkippedDownstreamTasksStatePayload_Tasks_Item) MarshalJSON

func (*TISkippedDownstreamTasksStatePayload_Tasks_Item) MergeTISkippedDownstreamTasksStatePayloadTasks0

func (t *TISkippedDownstreamTasksStatePayload_Tasks_Item) MergeTISkippedDownstreamTasksStatePayloadTasks0(v TISkippedDownstreamTasksStatePayloadTasks0) error

MergeTISkippedDownstreamTasksStatePayloadTasks0 performs a merge with any union data inside the TISkippedDownstreamTasksStatePayload_Tasks_Item, using the provided TISkippedDownstreamTasksStatePayloadTasks0

func (*TISkippedDownstreamTasksStatePayload_Tasks_Item) MergeTISkippedDownstreamTasksStatePayloadTasks1

func (t *TISkippedDownstreamTasksStatePayload_Tasks_Item) MergeTISkippedDownstreamTasksStatePayloadTasks1(v TISkippedDownstreamTasksStatePayloadTasks1) error

MergeTISkippedDownstreamTasksStatePayloadTasks1 performs a merge with any union data inside the TISkippedDownstreamTasksStatePayload_Tasks_Item, using the provided TISkippedDownstreamTasksStatePayloadTasks1

func (*TISkippedDownstreamTasksStatePayload_Tasks_Item) UnmarshalJSON

type TISuccessStatePayload

type TISuccessStatePayload struct {
	EndDate          time.Time                  `json:"end_date"`
	OutletEvents     *[]map[string]interface{}  `json:"outlet_events,omitempty"`
	RenderedMapIndex *string                    `json:"rendered_map_index"`
	State            TISuccessStatePayloadState `json:"state"`
	TaskOutlets      *[]AssetProfile            `json:"task_outlets,omitempty"`
}

TISuccessStatePayload Schema for updating TaskInstance to success state.

type TISuccessStatePayloadState

type TISuccessStatePayloadState string

TISuccessStatePayloadState defines model for TISuccessStatePayload.State.

const (
	TISuccessStatePayloadStateSuccess TISuccessStatePayloadState = "success"
)

Defines values for TISuccessStatePayloadState.

type TITargetStatePayload

type TITargetStatePayload struct {
	// State States that a Task Instance can be in that indicate it is not yet in a terminal or running state.
	State IntermediateTIState `json:"state"`
}

TITargetStatePayload Schema for updating TaskInstance to a target state, excluding terminal and running states.

type TITerminalStatePayload

type TITerminalStatePayload struct {
	EndDate          time.Time `json:"end_date"`
	RenderedMapIndex *string   `json:"rendered_map_index"`

	// State TaskInstance states that can be reported without extra information.
	State TerminalStateNonSuccess `json:"state"`
}

TITerminalStatePayload Schema for updating TaskInstance to a terminal state except SUCCESS state.

type TIUpdateStatePayload

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

TIUpdateStatePayload defines model for TIUpdateStatePayload.

func (TIUpdateStatePayload) AsTIDeferredStatePayload

func (t TIUpdateStatePayload) AsTIDeferredStatePayload() (TIDeferredStatePayload, error)

AsTIDeferredStatePayload returns the union data inside the TIUpdateStatePayload as a TIDeferredStatePayload

func (TIUpdateStatePayload) AsTIRescheduleStatePayload

func (t TIUpdateStatePayload) AsTIRescheduleStatePayload() (TIRescheduleStatePayload, error)

AsTIRescheduleStatePayload returns the union data inside the TIUpdateStatePayload as a TIRescheduleStatePayload

func (TIUpdateStatePayload) AsTIRetryStatePayload

func (t TIUpdateStatePayload) AsTIRetryStatePayload() (TIRetryStatePayload, error)

AsTIRetryStatePayload returns the union data inside the TIUpdateStatePayload as a TIRetryStatePayload

func (TIUpdateStatePayload) AsTISuccessStatePayload

func (t TIUpdateStatePayload) AsTISuccessStatePayload() (TISuccessStatePayload, error)

AsTISuccessStatePayload returns the union data inside the TIUpdateStatePayload as a TISuccessStatePayload

func (TIUpdateStatePayload) AsTITargetStatePayload

func (t TIUpdateStatePayload) AsTITargetStatePayload() (TITargetStatePayload, error)

AsTITargetStatePayload returns the union data inside the TIUpdateStatePayload as a TITargetStatePayload

func (TIUpdateStatePayload) AsTITerminalStatePayload

func (t TIUpdateStatePayload) AsTITerminalStatePayload() (TITerminalStatePayload, error)

AsTITerminalStatePayload returns the union data inside the TIUpdateStatePayload as a TITerminalStatePayload

func (*TIUpdateStatePayload) FromTIDeferredStatePayload

func (t *TIUpdateStatePayload) FromTIDeferredStatePayload(v TIDeferredStatePayload) error

FromTIDeferredStatePayload overwrites any union data inside the TIUpdateStatePayload as the provided TIDeferredStatePayload

func (*TIUpdateStatePayload) FromTIRescheduleStatePayload

func (t *TIUpdateStatePayload) FromTIRescheduleStatePayload(v TIRescheduleStatePayload) error

FromTIRescheduleStatePayload overwrites any union data inside the TIUpdateStatePayload as the provided TIRescheduleStatePayload

func (*TIUpdateStatePayload) FromTIRetryStatePayload

func (t *TIUpdateStatePayload) FromTIRetryStatePayload(v TIRetryStatePayload) error

FromTIRetryStatePayload overwrites any union data inside the TIUpdateStatePayload as the provided TIRetryStatePayload

func (*TIUpdateStatePayload) FromTISuccessStatePayload

func (t *TIUpdateStatePayload) FromTISuccessStatePayload(v TISuccessStatePayload) error

FromTISuccessStatePayload overwrites any union data inside the TIUpdateStatePayload as the provided TISuccessStatePayload

func (*TIUpdateStatePayload) FromTITargetStatePayload

func (t *TIUpdateStatePayload) FromTITargetStatePayload(v TITargetStatePayload) error

FromTITargetStatePayload overwrites any union data inside the TIUpdateStatePayload as the provided TITargetStatePayload

func (*TIUpdateStatePayload) FromTITerminalStatePayload

func (t *TIUpdateStatePayload) FromTITerminalStatePayload(v TITerminalStatePayload) error

FromTITerminalStatePayload overwrites any union data inside the TIUpdateStatePayload as the provided TITerminalStatePayload

func (TIUpdateStatePayload) MarshalJSON

func (t TIUpdateStatePayload) MarshalJSON() ([]byte, error)

func (*TIUpdateStatePayload) MergeTIDeferredStatePayload

func (t *TIUpdateStatePayload) MergeTIDeferredStatePayload(v TIDeferredStatePayload) error

MergeTIDeferredStatePayload performs a merge with any union data inside the TIUpdateStatePayload, using the provided TIDeferredStatePayload

func (*TIUpdateStatePayload) MergeTIRescheduleStatePayload

func (t *TIUpdateStatePayload) MergeTIRescheduleStatePayload(v TIRescheduleStatePayload) error

MergeTIRescheduleStatePayload performs a merge with any union data inside the TIUpdateStatePayload, using the provided TIRescheduleStatePayload

func (*TIUpdateStatePayload) MergeTIRetryStatePayload

func (t *TIUpdateStatePayload) MergeTIRetryStatePayload(v TIRetryStatePayload) error

MergeTIRetryStatePayload performs a merge with any union data inside the TIUpdateStatePayload, using the provided TIRetryStatePayload

func (*TIUpdateStatePayload) MergeTISuccessStatePayload

func (t *TIUpdateStatePayload) MergeTISuccessStatePayload(v TISuccessStatePayload) error

MergeTISuccessStatePayload performs a merge with any union data inside the TIUpdateStatePayload, using the provided TISuccessStatePayload

func (*TIUpdateStatePayload) MergeTITargetStatePayload

func (t *TIUpdateStatePayload) MergeTITargetStatePayload(v TITargetStatePayload) error

MergeTITargetStatePayload performs a merge with any union data inside the TIUpdateStatePayload, using the provided TITargetStatePayload

func (*TIUpdateStatePayload) MergeTITerminalStatePayload

func (t *TIUpdateStatePayload) MergeTITerminalStatePayload(v TITerminalStatePayload) error

MergeTITerminalStatePayload performs a merge with any union data inside the TIUpdateStatePayload, using the provided TITerminalStatePayload

func (*TIUpdateStatePayload) UnmarshalJSON

func (t *TIUpdateStatePayload) UnmarshalJSON(b []byte) error

type TaskInstance

type TaskInstance struct {
	ContextCarrier *map[string]interface{} `json:"context_carrier"`
	DagId          string                  `json:"dag_id"`
	Hostname       *string                 `json:"hostname"`
	Id             openapi_types.UUID      `json:"id"`
	MapIndex       *int                    `json:"map_index,omitempty"`
	RunId          string                  `json:"run_id"`
	TaskId         string                  `json:"task_id"`
	TryNumber      int                     `json:"try_number"`
}

TaskInstance Schema for TaskInstance model with minimal required fields needed for Runtime.

type TaskInstanceHeartbeatJSONRequestBody

type TaskInstanceHeartbeatJSONRequestBody = TIHeartbeatInfo

TaskInstanceHeartbeatJSONRequestBody defines body for TaskInstanceHeartbeat for application/json ContentType.

type TaskInstancePutRenderedFieldsJSONBody

type TaskInstancePutRenderedFieldsJSONBody map[string]*JsonValue

TaskInstancePutRenderedFieldsJSONBody defines parameters for TaskInstancePutRenderedFields.

type TaskInstancePutRenderedFieldsJSONRequestBody

type TaskInstancePutRenderedFieldsJSONRequestBody TaskInstancePutRenderedFieldsJSONBody

TaskInstancePutRenderedFieldsJSONRequestBody defines body for TaskInstancePutRenderedFields for application/json ContentType.

type TaskInstanceRunJSONRequestBody

type TaskInstanceRunJSONRequestBody = TIEnterRunningPayload

TaskInstanceRunJSONRequestBody defines body for TaskInstanceRun for application/json ContentType.

type TaskInstanceSkipDownstreamJSONRequestBody

type TaskInstanceSkipDownstreamJSONRequestBody = TISkippedDownstreamTasksStatePayload

TaskInstanceSkipDownstreamJSONRequestBody defines body for TaskInstanceSkipDownstream for application/json ContentType.

type TaskInstanceState

type TaskInstanceState string

TaskInstanceState defines model for TaskInstanceState.

const (
	TaskInstanceStateDeferred        TaskInstanceState = "deferred"
	TaskInstanceStateFailed          TaskInstanceState = "failed"
	TaskInstanceStateQueued          TaskInstanceState = "queued"
	TaskInstanceStateRemoved         TaskInstanceState = "removed"
	TaskInstanceStateRestarting      TaskInstanceState = "restarting"
	TaskInstanceStateRunning         TaskInstanceState = "running"
	TaskInstanceStateScheduled       TaskInstanceState = "scheduled"
	TaskInstanceStateSkipped         TaskInstanceState = "skipped"
	TaskInstanceStateSuccess         TaskInstanceState = "success"
	TaskInstanceStateUpForReschedule TaskInstanceState = "up_for_reschedule"
	TaskInstanceStateUpForRetry      TaskInstanceState = "up_for_retry"
	TaskInstanceStateUpstreamFailed  TaskInstanceState = "upstream_failed"
)

Defines values for TaskInstanceState.

type TaskInstanceUpdateStateJSONBody

type TaskInstanceUpdateStateJSONBody = TIUpdateStatePayload

TaskInstanceUpdateStateJSONBody defines parameters for TaskInstanceUpdateState.

type TaskInstanceUpdateStateJSONRequestBody

type TaskInstanceUpdateStateJSONRequestBody = TaskInstanceUpdateStateJSONBody

TaskInstanceUpdateStateJSONRequestBody defines body for TaskInstanceUpdateState for application/json ContentType.

type TaskInstancesClient

type TaskInstancesClient interface {
	// Get the count of task instances matching the given criteria.
	GetCount(ctx context.Context, params *GetTaskInstanceCountParams) (*int, error)
	// GetCountResponse is a lower level version of [GetCount] and provides access to the raw [resty.Response]
	GetCountResponse(ctx context.Context, params *GetTaskInstanceCountParams) (*resty.Response, error)

	// Get the states for Task Instances with the given criteria.
	GetStates(ctx context.Context, params *GetTaskInstanceStatesParams) (*TaskStatesResponse, error)
	// GetStatesResponse is a lower level version of [GetStates] and provides access to the raw [resty.Response]
	GetStatesResponse(ctx context.Context, params *GetTaskInstanceStatesParams) (*resty.Response, error)

	// Update the heartbeat of a TaskInstance to mark it as alive & still running.
	Heartbeat(ctx context.Context, taskInstanceId openapi_types.UUID, body *TIHeartbeatInfo) error
	// HeartbeatResponse is a lower level version of [Heartbeat] and provides access to the raw [resty.Response]
	HeartbeatResponse(ctx context.Context, taskInstanceId openapi_types.UUID, body *TIHeartbeatInfo) (*resty.Response, error)

	// Get the previous successful DagRun for a TaskInstance.
	//
	// The data from this endpoint is used to get values for Task Context.
	GetPreviousSuccessfulDagrun(ctx context.Context, taskInstanceId openapi_types.UUID) (*PrevSuccessfulDagRunResponse, error)
	// GetPreviousSuccessfulDagrunResponse is a lower level version of [GetPreviousSuccessfulDagrun] and provides access to the raw [resty.Response]
	GetPreviousSuccessfulDagrunResponse(ctx context.Context, taskInstanceId openapi_types.UUID) (*resty.Response, error)

	// Add an RTIF entry for a task instance, sent by the worker.
	PutRenderedFields(ctx context.Context, taskInstanceId openapi_types.UUID, body *map[string]*JsonValue) (*interface{}, error)
	// PutRenderedFieldsResponse is a lower level version of [PutRenderedFields] and provides access to the raw [resty.Response]
	PutRenderedFieldsResponse(ctx context.Context, taskInstanceId openapi_types.UUID, body *map[string]*JsonValue) (*resty.Response, error)

	// Run a TaskInstance.
	//
	// This endpoint is used to start a TaskInstance that is in the QUEUED state.
	Run(ctx context.Context, taskInstanceId openapi_types.UUID, body *TIEnterRunningPayload) (*TIRunContext, error)
	// RunResponse is a lower level version of [Run] and provides access to the raw [resty.Response]
	RunResponse(ctx context.Context, taskInstanceId openapi_types.UUID, body *TIEnterRunningPayload) (*resty.Response, error)

	SkipDownstream(ctx context.Context, taskInstanceId openapi_types.UUID, body *TISkippedDownstreamTasksStatePayload) error
	// SkipDownstreamResponse is a lower level version of [SkipDownstream] and provides access to the raw [resty.Response]
	SkipDownstreamResponse(ctx context.Context, taskInstanceId openapi_types.UUID, body *TISkippedDownstreamTasksStatePayload) (*resty.Response, error)

	// Update the state of a TaskInstance.
	//
	// Not all state transitions are valid, and transitioning to some states requires extra information to be
	// passed along. (Check out the datamodels for details, the rendered docs might not reflect this accurately)
	UpdateState(ctx context.Context, taskInstanceId openapi_types.UUID, body *TIUpdateStatePayload) error
	// UpdateStateResponse is a lower level version of [UpdateState] and provides access to the raw [resty.Response]
	UpdateStateResponse(ctx context.Context, taskInstanceId openapi_types.UUID, body *TIUpdateStatePayload) (*resty.Response, error)

	// Validate whether there're inactive assets in inlets and outlets of a given task instance.
	ValidateInletsAndOutlets(ctx context.Context, taskInstanceId openapi_types.UUID) (*InactiveAssetsResponse, error)
	// ValidateInletsAndOutletsResponse is a lower level version of [ValidateInletsAndOutlets] and provides access to the raw [resty.Response]
	ValidateInletsAndOutletsResponse(ctx context.Context, taskInstanceId openapi_types.UUID) (*resty.Response, error)
}

type TaskReschedulesClient

type TaskReschedulesClient interface {
	// Get the first reschedule date if found, None if no records exist.
	GetStartDate(ctx context.Context, taskInstanceId openapi_types.UUID) (*time.Time, error)
	// GetStartDateResponse is a lower level version of [GetStartDate] and provides access to the raw [resty.Response]
	GetStartDateResponse(ctx context.Context, taskInstanceId openapi_types.UUID) (*resty.Response, error)
}

type TaskStatesResponse

type TaskStatesResponse struct {
	TaskStates map[string]interface{} `json:"task_states"`
}

TaskStatesResponse Response for task states with run_id, task and state.

type TerminalStateNonSuccess

type TerminalStateNonSuccess string

TerminalStateNonSuccess TaskInstance states that can be reported without extra information.

const (
	Failed  TerminalStateNonSuccess = "failed"
	Removed TerminalStateNonSuccess = "removed"
	Skipped TerminalStateNonSuccess = "skipped"
)

Defines values for TerminalStateNonSuccess.

type TerminalTIState

type TerminalTIState string

TerminalTIState defines model for TerminalTIState.

const (
	TerminalTIStateFailed  TerminalTIState = "failed"
	TerminalTIStateRemoved TerminalTIState = "removed"
	TerminalTIStateSkipped TerminalTIState = "skipped"
	TerminalTIStateSuccess TerminalTIState = "success"
)

Defines values for TerminalTIState.

type TriggerDAGRunPayload

type TriggerDAGRunPayload struct {
	Conf        *map[string]interface{} `json:"conf,omitempty"`
	LogicalDate *time.Time              `json:"logical_date"`
	ResetDagRun *bool                   `json:"reset_dag_run,omitempty"`
}

TriggerDAGRunPayload Schema for Trigger DAG Run API request.

type TriggerDagRunJSONRequestBody

type TriggerDagRunJSONRequestBody = TriggerDAGRunPayload

TriggerDagRunJSONRequestBody defines body for TriggerDagRun for application/json ContentType.

type ValidationError

type ValidationError struct {
	Loc  []ValidationError_Loc_Item `json:"loc"`
	Msg  string                     `json:"msg"`
	Type string                     `json:"type"`
}

ValidationError defines model for ValidationError.

type ValidationErrorLoc0

type ValidationErrorLoc0 = string

ValidationErrorLoc0 defines model for .

type ValidationErrorLoc1

type ValidationErrorLoc1 = int

ValidationErrorLoc1 defines model for .

type ValidationError_Loc_Item

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

ValidationError_Loc_Item defines model for ValidationError.loc.Item.

func (ValidationError_Loc_Item) AsValidationErrorLoc0

func (t ValidationError_Loc_Item) AsValidationErrorLoc0() (ValidationErrorLoc0, error)

AsValidationErrorLoc0 returns the union data inside the ValidationError_Loc_Item as a ValidationErrorLoc0

func (ValidationError_Loc_Item) AsValidationErrorLoc1

func (t ValidationError_Loc_Item) AsValidationErrorLoc1() (ValidationErrorLoc1, error)

AsValidationErrorLoc1 returns the union data inside the ValidationError_Loc_Item as a ValidationErrorLoc1

func (*ValidationError_Loc_Item) FromValidationErrorLoc0

func (t *ValidationError_Loc_Item) FromValidationErrorLoc0(v ValidationErrorLoc0) error

FromValidationErrorLoc0 overwrites any union data inside the ValidationError_Loc_Item as the provided ValidationErrorLoc0

func (*ValidationError_Loc_Item) FromValidationErrorLoc1

func (t *ValidationError_Loc_Item) FromValidationErrorLoc1(v ValidationErrorLoc1) error

FromValidationErrorLoc1 overwrites any union data inside the ValidationError_Loc_Item as the provided ValidationErrorLoc1

func (ValidationError_Loc_Item) MarshalJSON

func (t ValidationError_Loc_Item) MarshalJSON() ([]byte, error)

func (*ValidationError_Loc_Item) MergeValidationErrorLoc0

func (t *ValidationError_Loc_Item) MergeValidationErrorLoc0(v ValidationErrorLoc0) error

MergeValidationErrorLoc0 performs a merge with any union data inside the ValidationError_Loc_Item, using the provided ValidationErrorLoc0

func (*ValidationError_Loc_Item) MergeValidationErrorLoc1

func (t *ValidationError_Loc_Item) MergeValidationErrorLoc1(v ValidationErrorLoc1) error

MergeValidationErrorLoc1 performs a merge with any union data inside the ValidationError_Loc_Item, using the provided ValidationErrorLoc1

func (*ValidationError_Loc_Item) UnmarshalJSON

func (t *ValidationError_Loc_Item) UnmarshalJSON(b []byte) error

type VariablePostBody

type VariablePostBody struct {
	Description *string `json:"description"`
	Val         *string `json:"val"`
}

VariablePostBody Request body schema for creating variables.

type VariableResponse

type VariableResponse struct {
	Key   string  `json:"key"`
	Value *string `json:"value"`
}

VariableResponse Variable schema for responses with fields that are needed for Runtime.

type VariablesClient

type VariablesClient interface {
	// Delete an Airflow Variable.
	Delete(ctx context.Context, variableKey string) (*HTTPValidationError, error)
	// DeleteResponse is a lower level version of [Delete] and provides access to the raw [resty.Response]
	DeleteResponse(ctx context.Context, variableKey string) (*resty.Response, error)

	// Get an Airflow Variable.
	Get(ctx context.Context, variableKey string) (*VariableResponse, error)
	// GetResponse is a lower level version of [Get] and provides access to the raw [resty.Response]
	GetResponse(ctx context.Context, variableKey string) (*resty.Response, error)

	// Set an Airflow Variable.
	Put(ctx context.Context, variableKey string, body *VariablePostBody) (*interface{}, error)
	// PutResponse is a lower level version of [Put] and provides access to the raw [resty.Response]
	PutResponse(ctx context.Context, variableKey string, body *VariablePostBody) (*resty.Response, error)
}

type XComResponse

type XComResponse struct {
	Key   string      `json:"key"`
	Value interface{} `json:"value"`
}

XComResponse XCom schema for responses with fields that are needed for Runtime.

type XComSequenceIndexResponse

type XComSequenceIndexResponse = interface{}

XComSequenceIndexResponse XCom schema with minimal structure for index-based access.

type XComSequenceSliceResponse

type XComSequenceSliceResponse = []interface{}

XComSequenceSliceResponse XCom schema with minimal structure for slice-based access.

type XcomsClient

type XcomsClient interface {
	// Delete a single XCom Value
	Delete(ctx context.Context, dagId string, runId string, taskId string, key string, params *DeleteXcomParams) (*interface{}, error)
	// DeleteResponse is a lower level version of [Delete] and provides access to the raw [resty.Response]
	DeleteResponse(ctx context.Context, dagId string, runId string, taskId string, key string, params *DeleteXcomParams) (*resty.Response, error)

	// Get a single XCom Value
	Get(ctx context.Context, dagId string, runId string, taskId string, key string, params *GetXcomParams) (*XComResponse, error)
	// GetResponse is a lower level version of [Get] and provides access to the raw [resty.Response]
	GetResponse(ctx context.Context, dagId string, runId string, taskId string, key string, params *GetXcomParams) (*resty.Response, error)

	// Returns the count of mapped XCom values found in the `Content-Range` response header
	Head(ctx context.Context, dagId string, runId string, taskId string, key string, params *HeadXcomParams) (*interface{}, error)
	// HeadResponse is a lower level version of [Head] and provides access to the raw [resty.Response]
	HeadResponse(ctx context.Context, dagId string, runId string, taskId string, key string, params *HeadXcomParams) (*resty.Response, error)

	// Set an Airflow XCom.
	Set(ctx context.Context, dagId string, runId string, taskId string, key string, params *SetXcomParams, body *interface{}) (*interface{}, error)
	// SetResponse is a lower level version of [Set] and provides access to the raw [resty.Response]
	SetResponse(ctx context.Context, dagId string, runId string, taskId string, key string, params *SetXcomParams, body *interface{}) (*resty.Response, error)

	// Get a single XCom value from a mapped task by sequence index
	GetMappedByIndex(ctx context.Context, dagId string, runId string, taskId string, key string, offset int) (*XComSequenceIndexResponse, error)
	// GetMappedByIndexResponse is a lower level version of [GetMappedByIndex] and provides access to the raw [resty.Response]
	GetMappedByIndexResponse(ctx context.Context, dagId string, runId string, taskId string, key string, offset int) (*resty.Response, error)

	// Get XCom values from a mapped task by sequence slice
	GetMappedBySlice(ctx context.Context, dagId string, runId string, taskId string, key string, params *GetMappedXcomBySliceParams) (*XComSequenceSliceResponse, error)
	// GetMappedBySliceResponse is a lower level version of [GetMappedBySlice] and provides access to the raw [resty.Response]
	GetMappedBySliceResponse(ctx context.Context, dagId string, runId string, taskId string, key string, params *GetMappedXcomBySliceParams) (*resty.Response, error)
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL