Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 3.89 KB

DagWarningApi.md

File metadata and controls

97 lines (71 loc) · 3.89 KB
Raw

airflow_client.client.DagWarningApi

All URIs are relative to /api/v1

Method HTTP request Description
get_dag_warnings GET /dagWarnings List dag warnings

get_dag_warnings

DagWarningCollection get_dag_warnings()

List dag warnings

Example

  • Basic Authentication (Basic):
import time
import airflow_client.client
from airflow_client.client.api import dag_warning_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.dag_warning_collection import DagWarningCollection
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
    host = "/api/v1"
)

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

# Configure HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# 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 = dag_warning_api.DagWarningApi(api_client)
    dag_id = "dag_id_example" # str | If set, only return DAG warnings with this dag_id. (optional)
    warning_type = "warning_type_example" # str | If set, only return DAG warnings with this type. (optional)
    limit = 100 # int | The numbers of items to return. (optional) if omitted the server will use the default value of 100
    offset = 0 # int | The number of items to skip before starting to collect the result set. (optional)
    order_by = "order_by_example" # str | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order.  *New in version 2.1.0*  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List dag warnings
        api_response = api_instance.get_dag_warnings(dag_id=dag_id, warning_type=warning_type, limit=limit, offset=offset, order_by=order_by)
        pprint(api_response)
    except airflow_client.client.ApiException as e:
        print("Exception when calling DagWarningApi->get_dag_warnings: %s\n" % e)

Parameters

Name Type Description Notes
dag_id str If set, only return DAG warnings with this dag_id. [optional]
warning_type str If set, only return DAG warnings with this type. [optional]
limit int The numbers of items to return. [optional] if omitted the server will use the default value of 100
offset int The number of items to skip before starting to collect the result set. [optional]
order_by str The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. New in version 2.1.0 [optional]

Return type

DagWarningCollection

Authorization

Basic, Kerberos

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success. -
401 Request not authenticated due to missing, invalid, authentication info. -
403 Client does not have sufficient permission. -

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