| # airflow_client.client.XComApi | |
| All URIs are relative to *http://localhost* | |
| Method | HTTP request | Description | |
| ------------- | ------------- | ------------- | |
| [**create_xcom_entry**](XComApi.md#create_xcom_entry) | **POST** /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries | Create Xcom Entry | |
| [**delete_xcom_entry**](XComApi.md#delete_xcom_entry) | **DELETE** /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key} | Delete Xcom Entry | |
| [**get_xcom_entries**](XComApi.md#get_xcom_entries) | **GET** /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries | Get Xcom Entries | |
| [**get_xcom_entry**](XComApi.md#get_xcom_entry) | **GET** /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key} | Get Xcom Entry | |
| [**update_xcom_entry**](XComApi.md#update_xcom_entry) | **PATCH** /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key} | Update Xcom Entry | |
| # **create_xcom_entry** | |
| > XComResponseNative create_xcom_entry(dag_id, task_id, dag_run_id, x_com_create_body) | |
| Create Xcom Entry | |
| Create an XCom entry. | |
| ### Example | |
| * OAuth Authentication (OAuth2PasswordBearer): | |
| * Bearer Authentication (HTTPBearer): | |
| ```python | |
| import airflow_client.client | |
| from airflow_client.client.models.x_com_create_body import XComCreateBody | |
| from airflow_client.client.models.x_com_response_native import XComResponseNative | |
| from airflow_client.client.rest import ApiException | |
| from pprint import pprint | |
| # Defining the host is optional and defaults to http://localhost | |
| # See configuration.py for a list of all supported configuration parameters. | |
| configuration = airflow_client.client.Configuration( | |
| host = "http://localhost" | |
| ) | |
| # The client must configure the authentication and authorization parameters | |
| # in accordance with the API server security policy. | |
| # Examples for each auth method are provided below, use the example that | |
| # satisfies your auth use case. | |
| configuration.access_token = os.environ["ACCESS_TOKEN"] | |
| # Configure Bearer authorization: HTTPBearer | |
| configuration = airflow_client.client.Configuration( | |
| access_token = os.environ["BEARER_TOKEN"] | |
| ) | |
| # Enter a context with an instance of the API client | |
| with airflow_client.client.ApiClient(configuration) as api_client: | |
| # Create an instance of the API class | |
| api_instance = airflow_client.client.XComApi(api_client) | |
| dag_id = 'dag_id_example' # str | | |
| task_id = 'task_id_example' # str | | |
| dag_run_id = 'dag_run_id_example' # str | | |
| x_com_create_body = airflow_client.client.XComCreateBody() # XComCreateBody | | |
| try: | |
| # Create Xcom Entry | |
| api_response = api_instance.create_xcom_entry(dag_id, task_id, dag_run_id, x_com_create_body) | |
| print("The response of XComApi->create_xcom_entry:\n") | |
| pprint(api_response) | |
| except Exception as e: | |
| print("Exception when calling XComApi->create_xcom_entry: %s\n" % e) | |
| ``` | |
| ### Parameters | |
| Name | Type | Description | Notes | |
| ------------- | ------------- | ------------- | ------------- | |
| **dag_id** | **str**| | | |
| **task_id** | **str**| | | |
| **dag_run_id** | **str**| | | |
| **x_com_create_body** | [**XComCreateBody**](XComCreateBody.md)| | | |
| ### Return type | |
| [**XComResponseNative**](XComResponseNative.md) | |
| ### Authorization | |
| [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer) | |
| ### HTTP request headers | |
| - **Content-Type**: application/json | |
| - **Accept**: application/json | |
| ### HTTP response details | |
| | Status code | Description | Response headers | | |
| |-------------|-------------|------------------| | |
| **201** | Successful Response | - | | |
| **400** | Bad Request | - | | |
| **401** | Unauthorized | - | | |
| **403** | Forbidden | - | | |
| **404** | Not Found | - | | |
| **409** | Conflict | - | | |
| **422** | Validation Error | - | | |
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) | |
| # **delete_xcom_entry** | |
| > delete_xcom_entry(dag_id, task_id, dag_run_id, xcom_key, map_index=map_index, region_id=region_id, region_index=region_index) | |
| Delete Xcom Entry | |
| Delete an XCom entry. | |
| ### Example | |
| * OAuth Authentication (OAuth2PasswordBearer): | |
| * Bearer Authentication (HTTPBearer): | |
| ```python | |
| import airflow_client.client | |
| from airflow_client.client.rest import ApiException | |
| from pprint import pprint | |
| # Defining the host is optional and defaults to http://localhost | |
| # See configuration.py for a list of all supported configuration parameters. | |
| configuration = airflow_client.client.Configuration( | |
| host = "http://localhost" | |
| ) | |
| # The client must configure the authentication and authorization parameters | |
| # in accordance with the API server security policy. | |
| # Examples for each auth method are provided below, use the example that | |
| # satisfies your auth use case. | |
| configuration.access_token = os.environ["ACCESS_TOKEN"] | |
| # Configure Bearer authorization: HTTPBearer | |
| configuration = airflow_client.client.Configuration( | |
| access_token = os.environ["BEARER_TOKEN"] | |
| ) | |
| # Enter a context with an instance of the API client | |
| with airflow_client.client.ApiClient(configuration) as api_client: | |
| # Create an instance of the API class | |
| api_instance = airflow_client.client.XComApi(api_client) | |
| dag_id = 'dag_id_example' # str | | |
| task_id = 'task_id_example' # str | | |
| dag_run_id = 'dag_run_id_example' # str | | |
| xcom_key = 'xcom_key_example' # str | | |
| map_index = -1 # int | (optional) (default to -1) | |
| region_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | (optional) | |
| region_index = 56 # int | (optional) | |
| try: | |
| # Delete Xcom Entry | |
| api_instance.delete_xcom_entry(dag_id, task_id, dag_run_id, xcom_key, map_index=map_index, region_id=region_id, region_index=region_index) | |
| except Exception as e: | |
| print("Exception when calling XComApi->delete_xcom_entry: %s\n" % e) | |
| ``` | |
| ### Parameters | |
| Name | Type | Description | Notes | |
| ------------- | ------------- | ------------- | ------------- | |
| **dag_id** | **str**| | | |
| **task_id** | **str**| | | |
| **dag_run_id** | **str**| | | |
| **xcom_key** | **str**| | | |
| **map_index** | **int**| | [optional] [default to -1] | |
| **region_id** | **UUID**| | [optional] | |
| **region_index** | **int**| | [optional] | |
| ### Return type | |
| void (empty response body) | |
| ### Authorization | |
| [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer) | |
| ### HTTP request headers | |
| - **Content-Type**: Not defined | |
| - **Accept**: application/json | |
| ### HTTP response details | |
| | Status code | Description | Response headers | | |
| |-------------|-------------|------------------| | |
| **204** | Successful Response | - | | |
| **400** | Bad Request | - | | |
| **401** | Unauthorized | - | | |
| **403** | Forbidden | - | | |
| **404** | Not Found | - | | |
| **409** | Conflict | - | | |
| **422** | Validation Error | - | | |
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) | |
| # **get_xcom_entries** | |
| > XComCollectionResponse get_xcom_entries(dag_id, dag_run_id, task_id, xcom_key=xcom_key, map_index=map_index, region_id=region_id, region_index=region_index, exclude_internal_keys=exclude_internal_keys, limit=limit, offset=offset, xcom_key_pattern=xcom_key_pattern, xcom_key_prefix_pattern=xcom_key_prefix_pattern, dag_display_name_pattern=dag_display_name_pattern, dag_display_name_prefix_pattern=dag_display_name_prefix_pattern, run_id_pattern=run_id_pattern, run_id_prefix_pattern=run_id_prefix_pattern, task_id_pattern=task_id_pattern, task_id_prefix_pattern=task_id_prefix_pattern, map_index_filter=map_index_filter, logical_date_gte=logical_date_gte, logical_date_gt=logical_date_gt, logical_date_lte=logical_date_lte, logical_date_lt=logical_date_lt, run_after_gte=run_after_gte, run_after_gt=run_after_gt, run_after_lte=run_after_lte, run_after_lt=run_after_lt, teams=teams, order_by=order_by) | |
| Get Xcom Entries | |
| Get all XCom entries. | |
| This endpoint allows specifying `~` as the dag_id, dag_run_id, task_id to retrieve XCom entries for all Dags. | |
| ### Example | |
| * OAuth Authentication (OAuth2PasswordBearer): | |
| * Bearer Authentication (HTTPBearer): | |
| ```python | |
| import airflow_client.client | |
| from airflow_client.client.models.x_com_collection_response import XComCollectionResponse | |
| from airflow_client.client.rest import ApiException | |
| from pprint import pprint | |
| # Defining the host is optional and defaults to http://localhost | |
| # See configuration.py for a list of all supported configuration parameters. | |
| configuration = airflow_client.client.Configuration( | |
| host = "http://localhost" | |
| ) | |
| # The client must configure the authentication and authorization parameters | |
| # in accordance with the API server security policy. | |
| # Examples for each auth method are provided below, use the example that | |
| # satisfies your auth use case. | |
| configuration.access_token = os.environ["ACCESS_TOKEN"] | |
| # Configure Bearer authorization: HTTPBearer | |
| configuration = airflow_client.client.Configuration( | |
| access_token = os.environ["BEARER_TOKEN"] | |
| ) | |
| # Enter a context with an instance of the API client | |
| with airflow_client.client.ApiClient(configuration) as api_client: | |
| # Create an instance of the API class | |
| api_instance = airflow_client.client.XComApi(api_client) | |
| dag_id = 'dag_id_example' # str | | |
| dag_run_id = 'dag_run_id_example' # str | | |
| task_id = 'task_id_example' # str | | |
| xcom_key = 'xcom_key_example' # str | (optional) | |
| map_index = 56 # int | (optional) | |
| region_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | (optional) | |
| region_index = 56 # int | (optional) | |
| exclude_internal_keys = False # bool | Leave out XComs whose keys Airflow reserves for itself, such as loop decision reasons. (optional) (default to False) | |
| limit = 50 # int | (optional) (default to 50) | |
| offset = 0 # int | (optional) (default to 0) | |
| xcom_key_pattern = 'xcom_key_pattern_example' # str | Case-insensitive substring match (SQL `ILIKE`). Slower than `xcom_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". (optional) | |
| xcom_key_prefix_pattern = 'xcom_key_prefix_pattern_example' # str | Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". (optional) | |
| dag_display_name_pattern = 'dag_display_name_pattern_example' # str | Case-insensitive substring match (SQL `ILIKE`). Slower than `dag_display_name_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". (optional) | |
| dag_display_name_prefix_pattern = 'dag_display_name_prefix_pattern_example' # str | Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". (optional) | |
| run_id_pattern = 'run_id_pattern_example' # str | Case-insensitive substring match (SQL `ILIKE`). Slower than `run_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". (optional) | |
| run_id_prefix_pattern = 'run_id_prefix_pattern_example' # str | Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". (optional) | |
| task_id_pattern = 'task_id_pattern_example' # str | Case-insensitive substring match (SQL `ILIKE`). Slower than `task_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". (optional) | |
| task_id_prefix_pattern = 'task_id_prefix_pattern_example' # str | Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". (optional) | |
| map_index_filter = 56 # int | (optional) | |
| logical_date_gte = '2013-10-20T19:20:30+01:00' # datetime | (optional) | |
| logical_date_gt = '2013-10-20T19:20:30+01:00' # datetime | (optional) | |
| logical_date_lte = '2013-10-20T19:20:30+01:00' # datetime | (optional) | |
| logical_date_lt = '2013-10-20T19:20:30+01:00' # datetime | (optional) | |
| run_after_gte = '2013-10-20T19:20:30+01:00' # datetime | (optional) | |
| run_after_gt = '2013-10-20T19:20:30+01:00' # datetime | (optional) | |
| run_after_lte = '2013-10-20T19:20:30+01:00' # datetime | (optional) | |
| run_after_lt = '2013-10-20T19:20:30+01:00' # datetime | (optional) | |
| teams = ['teams_example'] # List[str] | (optional) | |
| order_by = ["dag_id","task_id","run_id","region_id","region_index","key"] # List[str] | Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, dag_id, run_id, task_id, map_index, region_id, region_index, timestamp, run_after` (optional) (default to ["dag_id","task_id","run_id","region_id","region_index","key"]) | |
| try: | |
| # Get Xcom Entries | |
| api_response = api_instance.get_xcom_entries(dag_id, dag_run_id, task_id, xcom_key=xcom_key, map_index=map_index, region_id=region_id, region_index=region_index, exclude_internal_keys=exclude_internal_keys, limit=limit, offset=offset, xcom_key_pattern=xcom_key_pattern, xcom_key_prefix_pattern=xcom_key_prefix_pattern, dag_display_name_pattern=dag_display_name_pattern, dag_display_name_prefix_pattern=dag_display_name_prefix_pattern, run_id_pattern=run_id_pattern, run_id_prefix_pattern=run_id_prefix_pattern, task_id_pattern=task_id_pattern, task_id_prefix_pattern=task_id_prefix_pattern, map_index_filter=map_index_filter, logical_date_gte=logical_date_gte, logical_date_gt=logical_date_gt, logical_date_lte=logical_date_lte, logical_date_lt=logical_date_lt, run_after_gte=run_after_gte, run_after_gt=run_after_gt, run_after_lte=run_after_lte, run_after_lt=run_after_lt, teams=teams, order_by=order_by) | |
| print("The response of XComApi->get_xcom_entries:\n") | |
| pprint(api_response) | |
| except Exception as e: | |
| print("Exception when calling XComApi->get_xcom_entries: %s\n" % e) | |
| ``` | |
| ### Parameters | |
| Name | Type | Description | Notes | |
| ------------- | ------------- | ------------- | ------------- | |
| **dag_id** | **str**| | | |
| **dag_run_id** | **str**| | | |
| **task_id** | **str**| | | |
| **xcom_key** | **str**| | [optional] | |
| **map_index** | **int**| | [optional] | |
| **region_id** | **UUID**| | [optional] | |
| **region_index** | **int**| | [optional] | |
| **exclude_internal_keys** | **bool**| Leave out XComs whose keys Airflow reserves for itself, such as loop decision reasons. | [optional] [default to False] | |
| **limit** | **int**| | [optional] [default to 50] | |
| **offset** | **int**| | [optional] [default to 0] | |
| **xcom_key_pattern** | **str**| Case-insensitive substring match (SQL `ILIKE`). Slower than `xcom_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". | [optional] | |
| **xcom_key_prefix_pattern** | **str**| Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". | [optional] | |
| **dag_display_name_pattern** | **str**| Case-insensitive substring match (SQL `ILIKE`). Slower than `dag_display_name_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". | [optional] | |
| **dag_display_name_prefix_pattern** | **str**| Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". | [optional] | |
| **run_id_pattern** | **str**| Case-insensitive substring match (SQL `ILIKE`). Slower than `run_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". | [optional] | |
| **run_id_prefix_pattern** | **str**| Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". | [optional] | |
| **task_id_pattern** | **str**| Case-insensitive substring match (SQL `ILIKE`). Slower than `task_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". | [optional] | |
| **task_id_prefix_pattern** | **str**| Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". | [optional] | |
| **map_index_filter** | **int**| | [optional] | |
| **logical_date_gte** | **datetime**| | [optional] | |
| **logical_date_gt** | **datetime**| | [optional] | |
| **logical_date_lte** | **datetime**| | [optional] | |
| **logical_date_lt** | **datetime**| | [optional] | |
| **run_after_gte** | **datetime**| | [optional] | |
| **run_after_gt** | **datetime**| | [optional] | |
| **run_after_lte** | **datetime**| | [optional] | |
| **run_after_lt** | **datetime**| | [optional] | |
| **teams** | [**List[str]**](str.md)| | [optional] | |
| **order_by** | [**List[str]**](str.md)| Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, dag_id, run_id, task_id, map_index, region_id, region_index, timestamp, run_after` | [optional] [default to ["dag_id","task_id","run_id","region_id","region_index","key"]] | |
| ### Return type | |
| [**XComCollectionResponse**](XComCollectionResponse.md) | |
| ### Authorization | |
| [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer) | |
| ### HTTP request headers | |
| - **Content-Type**: Not defined | |
| - **Accept**: application/json | |
| ### HTTP response details | |
| | Status code | Description | Response headers | | |
| |-------------|-------------|------------------| | |
| **200** | Successful Response | - | | |
| **400** | Bad Request | - | | |
| **401** | Unauthorized | - | | |
| **403** | Forbidden | - | | |
| **404** | Not Found | - | | |
| **422** | Validation Error | - | | |
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) | |
| # **get_xcom_entry** | |
| > ResponseGetXcomEntry get_xcom_entry(dag_id, task_id, dag_run_id, xcom_key, map_index=map_index, region_id=region_id, region_index=region_index, deserialize=deserialize, stringify=stringify) | |
| Get Xcom Entry | |
| Get an XCom entry. | |
| ### Example | |
| * OAuth Authentication (OAuth2PasswordBearer): | |
| * Bearer Authentication (HTTPBearer): | |
| ```python | |
| import airflow_client.client | |
| from airflow_client.client.models.response_get_xcom_entry import ResponseGetXcomEntry | |
| from airflow_client.client.rest import ApiException | |
| from pprint import pprint | |
| # Defining the host is optional and defaults to http://localhost | |
| # See configuration.py for a list of all supported configuration parameters. | |
| configuration = airflow_client.client.Configuration( | |
| host = "http://localhost" | |
| ) | |
| # The client must configure the authentication and authorization parameters | |
| # in accordance with the API server security policy. | |
| # Examples for each auth method are provided below, use the example that | |
| # satisfies your auth use case. | |
| configuration.access_token = os.environ["ACCESS_TOKEN"] | |
| # Configure Bearer authorization: HTTPBearer | |
| configuration = airflow_client.client.Configuration( | |
| access_token = os.environ["BEARER_TOKEN"] | |
| ) | |
| # Enter a context with an instance of the API client | |
| with airflow_client.client.ApiClient(configuration) as api_client: | |
| # Create an instance of the API class | |
| api_instance = airflow_client.client.XComApi(api_client) | |
| dag_id = 'dag_id_example' # str | | |
| task_id = 'task_id_example' # str | | |
| dag_run_id = 'dag_run_id_example' # str | | |
| xcom_key = 'xcom_key_example' # str | | |
| map_index = -1 # int | (optional) (default to -1) | |
| region_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | (optional) | |
| region_index = 56 # int | (optional) | |
| deserialize = False # bool | (optional) (default to False) | |
| stringify = False # bool | (optional) (default to False) | |
| try: | |
| # Get Xcom Entry | |
| api_response = api_instance.get_xcom_entry(dag_id, task_id, dag_run_id, xcom_key, map_index=map_index, region_id=region_id, region_index=region_index, deserialize=deserialize, stringify=stringify) | |
| print("The response of XComApi->get_xcom_entry:\n") | |
| pprint(api_response) | |
| except Exception as e: | |
| print("Exception when calling XComApi->get_xcom_entry: %s\n" % e) | |
| ``` | |
| ### Parameters | |
| Name | Type | Description | Notes | |
| ------------- | ------------- | ------------- | ------------- | |
| **dag_id** | **str**| | | |
| **task_id** | **str**| | | |
| **dag_run_id** | **str**| | | |
| **xcom_key** | **str**| | | |
| **map_index** | **int**| | [optional] [default to -1] | |
| **region_id** | **UUID**| | [optional] | |
| **region_index** | **int**| | [optional] | |
| **deserialize** | **bool**| | [optional] [default to False] | |
| **stringify** | **bool**| | [optional] [default to False] | |
| ### Return type | |
| [**ResponseGetXcomEntry**](ResponseGetXcomEntry.md) | |
| ### Authorization | |
| [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer) | |
| ### HTTP request headers | |
| - **Content-Type**: Not defined | |
| - **Accept**: application/json | |
| ### HTTP response details | |
| | Status code | Description | Response headers | | |
| |-------------|-------------|------------------| | |
| **200** | Successful Response | - | | |
| **400** | Bad Request | - | | |
| **401** | Unauthorized | - | | |
| **403** | Forbidden | - | | |
| **404** | Not Found | - | | |
| **409** | Conflict | - | | |
| **422** | Validation Error | - | | |
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) | |
| # **update_xcom_entry** | |
| > XComResponseNative update_xcom_entry(dag_id, task_id, dag_run_id, xcom_key, x_com_update_body) | |
| Update Xcom Entry | |
| Update an existing XCom entry. | |
| ### Example | |
| * OAuth Authentication (OAuth2PasswordBearer): | |
| * Bearer Authentication (HTTPBearer): | |
| ```python | |
| import airflow_client.client | |
| from airflow_client.client.models.x_com_response_native import XComResponseNative | |
| from airflow_client.client.models.x_com_update_body import XComUpdateBody | |
| from airflow_client.client.rest import ApiException | |
| from pprint import pprint | |
| # Defining the host is optional and defaults to http://localhost | |
| # See configuration.py for a list of all supported configuration parameters. | |
| configuration = airflow_client.client.Configuration( | |
| host = "http://localhost" | |
| ) | |
| # The client must configure the authentication and authorization parameters | |
| # in accordance with the API server security policy. | |
| # Examples for each auth method are provided below, use the example that | |
| # satisfies your auth use case. | |
| configuration.access_token = os.environ["ACCESS_TOKEN"] | |
| # Configure Bearer authorization: HTTPBearer | |
| configuration = airflow_client.client.Configuration( | |
| access_token = os.environ["BEARER_TOKEN"] | |
| ) | |
| # Enter a context with an instance of the API client | |
| with airflow_client.client.ApiClient(configuration) as api_client: | |
| # Create an instance of the API class | |
| api_instance = airflow_client.client.XComApi(api_client) | |
| dag_id = 'dag_id_example' # str | | |
| task_id = 'task_id_example' # str | | |
| dag_run_id = 'dag_run_id_example' # str | | |
| xcom_key = 'xcom_key_example' # str | | |
| x_com_update_body = airflow_client.client.XComUpdateBody() # XComUpdateBody | | |
| try: | |
| # Update Xcom Entry | |
| api_response = api_instance.update_xcom_entry(dag_id, task_id, dag_run_id, xcom_key, x_com_update_body) | |
| print("The response of XComApi->update_xcom_entry:\n") | |
| pprint(api_response) | |
| except Exception as e: | |
| print("Exception when calling XComApi->update_xcom_entry: %s\n" % e) | |
| ``` | |
| ### Parameters | |
| Name | Type | Description | Notes | |
| ------------- | ------------- | ------------- | ------------- | |
| **dag_id** | **str**| | | |
| **task_id** | **str**| | | |
| **dag_run_id** | **str**| | | |
| **xcom_key** | **str**| | | |
| **x_com_update_body** | [**XComUpdateBody**](XComUpdateBody.md)| | | |
| ### Return type | |
| [**XComResponseNative**](XComResponseNative.md) | |
| ### Authorization | |
| [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer) | |
| ### HTTP request headers | |
| - **Content-Type**: application/json | |
| - **Accept**: application/json | |
| ### HTTP response details | |
| | Status code | Description | Response headers | | |
| |-------------|-------------|------------------| | |
| **200** | Successful Response | - | | |
| **400** | Bad Request | - | | |
| **401** | Unauthorized | - | | |
| **403** | Forbidden | - | | |
| **404** | Not Found | - | | |
| **409** | Conflict | - | | |
| **422** | Validation Error | - | | |
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) | |