\XComApi

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

Method	HTTP request	Description
GetXcomEntries	Get /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries	Get all XCom entries
GetXcomEntry	Get /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}	Get an XCom entry

GetXcomEntries

XComCollection GetXcomEntries(ctx, dagId, dagRunId, taskId, optional)

Get all XCom entries

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

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
dagId	string	The DAG ID.
dagRunId	string	The DAG Run ID.
taskId	string	The Task ID.
optional	*GetXcomEntriesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetXcomEntriesOpts struct

Name	Type	Description	Notes

limit | optional.Int32| The numbers of items to return. | [default to 100] offset | optional.Int32| The number of items to skip before starting to collect the result set. |

Return type

XComCollection

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetXcomEntry

XCom GetXcomEntry(ctx, dagId, dagRunId, taskId, xcomKey)

Get an XCom entry

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
dagId	string	The DAG ID.
dagRunId	string	The DAG Run ID.
taskId	string	The Task ID.
xcomKey	string	The XCom Key.

Return type

XCom

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]