| """ | |
| Airflow API | |
| Airflow API. All endpoints located under ``/api/v2`` can be used safely, are stable and backward compatible. Endpoints located under ``/ui`` are dedicated to the UI and are subject to breaking change depending on the need of the frontend. Users should not rely on those but use the public ones instead. **Filtering with pattern parameters.** Many list endpoints accept ``*_pattern`` and ``*_prefix_pattern`` query parameters. Unless a parameter's own description says otherwise, ``*_pattern`` is a case-insensitive substring match (SQL ``ILIKE '%term%'``) where ``%`` matches any sequence and ``_`` matches any single character (e.g. ``%customer_%``) — convenient, but it cannot use B-tree indexes, so it is slow on large tables. ``*_prefix_pattern`` matches the start of the value, is case-sensitive and index-friendly (prefer it at scale); there ``%`` and ``_`` are literal and trailing non-alphanumeric characters are stripped so the range scan stays index-compatible under locale-aware collations (e.g. ``test_`` matches values starting with ``test``, and ``s3://`` matches ``s3``). In both, ``|`` means OR (e.g. ``dag1|dag2``) and ``~`` matches everything. Regular expressions are not supported by these parameters; regex-capable endpoints expose a separate parameter. | |
| The version of the OpenAPI document: 2 | |
| Generated by OpenAPI Generator (https://openapi-generator.tech) | |
| Do not edit the class manually. | |
| """ # noqa: E501 | |
| import warnings | |
| from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt | |
| from typing import Any, Dict, List, Optional, Tuple, Union | |
| from typing_extensions import Annotated | |
| from pydantic import Field, StrictStr | |
| from typing import List, Optional | |
| from typing_extensions import Annotated | |
| from airflow_client.client.models.dag_bundle_collection_response import DagBundleCollectionResponse | |
| from airflow_client.client.models.dag_bundle_detail_response import DagBundleDetailResponse | |
| from airflow_client.client.models.dag_bundle_file_collection_response import DagBundleFileCollectionResponse | |
| from airflow_client.client.api_client import ApiClient, RequestSerialized | |
| from airflow_client.client.api_response import ApiResponse | |
| from airflow_client.client.rest import RESTResponseType | |
| class DagBundleApi: | |
| """NOTE: This class is auto generated by OpenAPI Generator | |
| Ref: https://openapi-generator.tech | |
| Do not edit the class manually. | |
| """ | |
| def __init__(self, api_client=None) -> None: | |
| if api_client is None: | |
| api_client = ApiClient.get_default() | |
| self.api_client = api_client | |
| @validate_call | |
| def get_dag_bundle( | |
| self, | |
| bundle_name: StrictStr, | |
| _request_timeout: Union[ | |
| None, | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Tuple[ | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Annotated[StrictFloat, Field(gt=0)] | |
| ] | |
| ] = None, | |
| _request_auth: Optional[Dict[StrictStr, Any]] = None, | |
| _content_type: Optional[StrictStr] = None, | |
| _headers: Optional[Dict[StrictStr, Any]] = None, | |
| _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, | |
| ) -> DagBundleDetailResponse: | |
| """Get Dag Bundle | |
| Get a Dag bundle. | |
| :param bundle_name: (required) | |
| :type bundle_name: str | |
| :param _request_timeout: timeout setting for this request. If one | |
| number provided, it will be total request | |
| timeout. It can also be a pair (tuple) of | |
| (connection, read) timeouts. | |
| :type _request_timeout: int, tuple(int, int), optional | |
| :param _request_auth: set to override the auth_settings for an a single | |
| request; this effectively ignores the | |
| authentication in the spec for a single request. | |
| :type _request_auth: dict, optional | |
| :param _content_type: force content-type for the request. | |
| :type _content_type: str, Optional | |
| :param _headers: set to override the headers for a single | |
| request; this effectively ignores the headers | |
| in the spec for a single request. | |
| :type _headers: dict, optional | |
| :param _host_index: set to override the host_index for a single | |
| request; this effectively ignores the host_index | |
| in the spec for a single request. | |
| :type _host_index: int, optional | |
| :return: Returns the result object. | |
| """ # noqa: E501 | |
| _param = self._get_dag_bundle_serialize( | |
| bundle_name=bundle_name, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "DagBundleDetailResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '404': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| response_data.read() | |
| return self.api_client.response_deserialize( | |
| response_data=response_data, | |
| response_types_map=_response_types_map, | |
| ).data | |
| @validate_call | |
| def get_dag_bundle_with_http_info( | |
| self, | |
| bundle_name: StrictStr, | |
| _request_timeout: Union[ | |
| None, | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Tuple[ | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Annotated[StrictFloat, Field(gt=0)] | |
| ] | |
| ] = None, | |
| _request_auth: Optional[Dict[StrictStr, Any]] = None, | |
| _content_type: Optional[StrictStr] = None, | |
| _headers: Optional[Dict[StrictStr, Any]] = None, | |
| _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, | |
| ) -> ApiResponse[DagBundleDetailResponse]: | |
| """Get Dag Bundle | |
| Get a Dag bundle. | |
| :param bundle_name: (required) | |
| :type bundle_name: str | |
| :param _request_timeout: timeout setting for this request. If one | |
| number provided, it will be total request | |
| timeout. It can also be a pair (tuple) of | |
| (connection, read) timeouts. | |
| :type _request_timeout: int, tuple(int, int), optional | |
| :param _request_auth: set to override the auth_settings for an a single | |
| request; this effectively ignores the | |
| authentication in the spec for a single request. | |
| :type _request_auth: dict, optional | |
| :param _content_type: force content-type for the request. | |
| :type _content_type: str, Optional | |
| :param _headers: set to override the headers for a single | |
| request; this effectively ignores the headers | |
| in the spec for a single request. | |
| :type _headers: dict, optional | |
| :param _host_index: set to override the host_index for a single | |
| request; this effectively ignores the host_index | |
| in the spec for a single request. | |
| :type _host_index: int, optional | |
| :return: Returns the result object. | |
| """ # noqa: E501 | |
| _param = self._get_dag_bundle_serialize( | |
| bundle_name=bundle_name, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "DagBundleDetailResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '404': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| response_data.read() | |
| return self.api_client.response_deserialize( | |
| response_data=response_data, | |
| response_types_map=_response_types_map, | |
| ) | |
| @validate_call | |
| def get_dag_bundle_without_preload_content( | |
| self, | |
| bundle_name: StrictStr, | |
| _request_timeout: Union[ | |
| None, | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Tuple[ | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Annotated[StrictFloat, Field(gt=0)] | |
| ] | |
| ] = None, | |
| _request_auth: Optional[Dict[StrictStr, Any]] = None, | |
| _content_type: Optional[StrictStr] = None, | |
| _headers: Optional[Dict[StrictStr, Any]] = None, | |
| _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, | |
| ) -> RESTResponseType: | |
| """Get Dag Bundle | |
| Get a Dag bundle. | |
| :param bundle_name: (required) | |
| :type bundle_name: str | |
| :param _request_timeout: timeout setting for this request. If one | |
| number provided, it will be total request | |
| timeout. It can also be a pair (tuple) of | |
| (connection, read) timeouts. | |
| :type _request_timeout: int, tuple(int, int), optional | |
| :param _request_auth: set to override the auth_settings for an a single | |
| request; this effectively ignores the | |
| authentication in the spec for a single request. | |
| :type _request_auth: dict, optional | |
| :param _content_type: force content-type for the request. | |
| :type _content_type: str, Optional | |
| :param _headers: set to override the headers for a single | |
| request; this effectively ignores the headers | |
| in the spec for a single request. | |
| :type _headers: dict, optional | |
| :param _host_index: set to override the host_index for a single | |
| request; this effectively ignores the host_index | |
| in the spec for a single request. | |
| :type _host_index: int, optional | |
| :return: Returns the result object. | |
| """ # noqa: E501 | |
| _param = self._get_dag_bundle_serialize( | |
| bundle_name=bundle_name, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "DagBundleDetailResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '404': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| return response_data.response | |
| def _get_dag_bundle_serialize( | |
| self, | |
| bundle_name, | |
| _request_auth, | |
| _content_type, | |
| _headers, | |
| _host_index, | |
| ) -> RequestSerialized: | |
| _host = None | |
| _collection_formats: Dict[str, str] = { | |
| } | |
| _path_params: Dict[str, str] = {} | |
| _query_params: List[Tuple[str, str]] = [] | |
| _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) | |
| _form_params: List[Tuple[str, str]] = [] | |
| _files: Dict[ | |
| str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] | |
| ] = {} | |
| _body_params: Optional[bytes] = None | |
| # process the path parameters | |
| if bundle_name is not None: | |
| _path_params['bundle_name'] = bundle_name | |
| # process the query parameters | |
| # process the header parameters | |
| # process the form parameters | |
| # process the body parameter | |
| # set the HTTP header `Accept` | |
| if not any(key.lower() == 'accept' for key in _header_params): | |
| _header_params['Accept'] = self.api_client.select_header_accept( | |
| [ | |
| 'application/json' | |
| ] | |
| ) | |
| # authentication setting | |
| _auth_settings: List[str] = [ | |
| 'OAuth2PasswordBearer', | |
| 'HTTPBearer' | |
| ] | |
| return self.api_client.param_serialize( | |
| method='GET', | |
| resource_path='/api/v2/dagBundles/{bundle_name}', | |
| path_params=_path_params, | |
| query_params=_query_params, | |
| header_params=_header_params, | |
| body=_body_params, | |
| post_params=_form_params, | |
| files=_files, | |
| auth_settings=_auth_settings, | |
| collection_formats=_collection_formats, | |
| _host=_host, | |
| _request_auth=_request_auth | |
| ) | |
| @validate_call | |
| def get_dag_bundle_files( | |
| self, | |
| bundle_name: StrictStr, | |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| _request_timeout: Union[ | |
| None, | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Tuple[ | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Annotated[StrictFloat, Field(gt=0)] | |
| ] | |
| ] = None, | |
| _request_auth: Optional[Dict[StrictStr, Any]] = None, | |
| _content_type: Optional[StrictStr] = None, | |
| _headers: Optional[Dict[StrictStr, Any]] = None, | |
| _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, | |
| ) -> DagBundleFileCollectionResponse: | |
| """Get Dag Bundle Files | |
| List the files in a Dag bundle, ordered by path. A file is listed when the caller can read at least one Dag it defines. A file that recorded an import error without registering any Dag is listed too, on the same admin-by-default terms as ``GET /importErrors`` -- a file that fails before defining a Dag has no Dag to authorize on, and it is the case this page most needs to show. ``dag_count`` counts live Dags only. Dag rows are never deleted: a file that fails to import has every Dag in it marked stale, and so does a file dropped from the bundle. A file therefore stays listed on the strength of a live Dag *or* an import error, so a file that has just broken does not vanish from the page someone opened to find out why, while a file deleted long ago drops out instead of lingering forever. Parse times come from the Dags in the file rather than the file itself, which is the only record Airflow keeps: a file whose every Dag was removed keeps no parse time of its own. | |
| :param bundle_name: (required) | |
| :type bundle_name: str | |
| :param limit: | |
| :type limit: int | |
| :param offset: | |
| :type offset: int | |
| :param _request_timeout: timeout setting for this request. If one | |
| number provided, it will be total request | |
| timeout. It can also be a pair (tuple) of | |
| (connection, read) timeouts. | |
| :type _request_timeout: int, tuple(int, int), optional | |
| :param _request_auth: set to override the auth_settings for an a single | |
| request; this effectively ignores the | |
| authentication in the spec for a single request. | |
| :type _request_auth: dict, optional | |
| :param _content_type: force content-type for the request. | |
| :type _content_type: str, Optional | |
| :param _headers: set to override the headers for a single | |
| request; this effectively ignores the headers | |
| in the spec for a single request. | |
| :type _headers: dict, optional | |
| :param _host_index: set to override the host_index for a single | |
| request; this effectively ignores the host_index | |
| in the spec for a single request. | |
| :type _host_index: int, optional | |
| :return: Returns the result object. | |
| """ # noqa: E501 | |
| _param = self._get_dag_bundle_files_serialize( | |
| bundle_name=bundle_name, | |
| limit=limit, | |
| offset=offset, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "DagBundleFileCollectionResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '404': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| response_data.read() | |
| return self.api_client.response_deserialize( | |
| response_data=response_data, | |
| response_types_map=_response_types_map, | |
| ).data | |
| @validate_call | |
| def get_dag_bundle_files_with_http_info( | |
| self, | |
| bundle_name: StrictStr, | |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| _request_timeout: Union[ | |
| None, | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Tuple[ | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Annotated[StrictFloat, Field(gt=0)] | |
| ] | |
| ] = None, | |
| _request_auth: Optional[Dict[StrictStr, Any]] = None, | |
| _content_type: Optional[StrictStr] = None, | |
| _headers: Optional[Dict[StrictStr, Any]] = None, | |
| _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, | |
| ) -> ApiResponse[DagBundleFileCollectionResponse]: | |
| """Get Dag Bundle Files | |
| List the files in a Dag bundle, ordered by path. A file is listed when the caller can read at least one Dag it defines. A file that recorded an import error without registering any Dag is listed too, on the same admin-by-default terms as ``GET /importErrors`` -- a file that fails before defining a Dag has no Dag to authorize on, and it is the case this page most needs to show. ``dag_count`` counts live Dags only. Dag rows are never deleted: a file that fails to import has every Dag in it marked stale, and so does a file dropped from the bundle. A file therefore stays listed on the strength of a live Dag *or* an import error, so a file that has just broken does not vanish from the page someone opened to find out why, while a file deleted long ago drops out instead of lingering forever. Parse times come from the Dags in the file rather than the file itself, which is the only record Airflow keeps: a file whose every Dag was removed keeps no parse time of its own. | |
| :param bundle_name: (required) | |
| :type bundle_name: str | |
| :param limit: | |
| :type limit: int | |
| :param offset: | |
| :type offset: int | |
| :param _request_timeout: timeout setting for this request. If one | |
| number provided, it will be total request | |
| timeout. It can also be a pair (tuple) of | |
| (connection, read) timeouts. | |
| :type _request_timeout: int, tuple(int, int), optional | |
| :param _request_auth: set to override the auth_settings for an a single | |
| request; this effectively ignores the | |
| authentication in the spec for a single request. | |
| :type _request_auth: dict, optional | |
| :param _content_type: force content-type for the request. | |
| :type _content_type: str, Optional | |
| :param _headers: set to override the headers for a single | |
| request; this effectively ignores the headers | |
| in the spec for a single request. | |
| :type _headers: dict, optional | |
| :param _host_index: set to override the host_index for a single | |
| request; this effectively ignores the host_index | |
| in the spec for a single request. | |
| :type _host_index: int, optional | |
| :return: Returns the result object. | |
| """ # noqa: E501 | |
| _param = self._get_dag_bundle_files_serialize( | |
| bundle_name=bundle_name, | |
| limit=limit, | |
| offset=offset, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "DagBundleFileCollectionResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '404': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| response_data.read() | |
| return self.api_client.response_deserialize( | |
| response_data=response_data, | |
| response_types_map=_response_types_map, | |
| ) | |
| @validate_call | |
| def get_dag_bundle_files_without_preload_content( | |
| self, | |
| bundle_name: StrictStr, | |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| _request_timeout: Union[ | |
| None, | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Tuple[ | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Annotated[StrictFloat, Field(gt=0)] | |
| ] | |
| ] = None, | |
| _request_auth: Optional[Dict[StrictStr, Any]] = None, | |
| _content_type: Optional[StrictStr] = None, | |
| _headers: Optional[Dict[StrictStr, Any]] = None, | |
| _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, | |
| ) -> RESTResponseType: | |
| """Get Dag Bundle Files | |
| List the files in a Dag bundle, ordered by path. A file is listed when the caller can read at least one Dag it defines. A file that recorded an import error without registering any Dag is listed too, on the same admin-by-default terms as ``GET /importErrors`` -- a file that fails before defining a Dag has no Dag to authorize on, and it is the case this page most needs to show. ``dag_count`` counts live Dags only. Dag rows are never deleted: a file that fails to import has every Dag in it marked stale, and so does a file dropped from the bundle. A file therefore stays listed on the strength of a live Dag *or* an import error, so a file that has just broken does not vanish from the page someone opened to find out why, while a file deleted long ago drops out instead of lingering forever. Parse times come from the Dags in the file rather than the file itself, which is the only record Airflow keeps: a file whose every Dag was removed keeps no parse time of its own. | |
| :param bundle_name: (required) | |
| :type bundle_name: str | |
| :param limit: | |
| :type limit: int | |
| :param offset: | |
| :type offset: int | |
| :param _request_timeout: timeout setting for this request. If one | |
| number provided, it will be total request | |
| timeout. It can also be a pair (tuple) of | |
| (connection, read) timeouts. | |
| :type _request_timeout: int, tuple(int, int), optional | |
| :param _request_auth: set to override the auth_settings for an a single | |
| request; this effectively ignores the | |
| authentication in the spec for a single request. | |
| :type _request_auth: dict, optional | |
| :param _content_type: force content-type for the request. | |
| :type _content_type: str, Optional | |
| :param _headers: set to override the headers for a single | |
| request; this effectively ignores the headers | |
| in the spec for a single request. | |
| :type _headers: dict, optional | |
| :param _host_index: set to override the host_index for a single | |
| request; this effectively ignores the host_index | |
| in the spec for a single request. | |
| :type _host_index: int, optional | |
| :return: Returns the result object. | |
| """ # noqa: E501 | |
| _param = self._get_dag_bundle_files_serialize( | |
| bundle_name=bundle_name, | |
| limit=limit, | |
| offset=offset, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "DagBundleFileCollectionResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '404': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| return response_data.response | |
| def _get_dag_bundle_files_serialize( | |
| self, | |
| bundle_name, | |
| limit, | |
| offset, | |
| _request_auth, | |
| _content_type, | |
| _headers, | |
| _host_index, | |
| ) -> RequestSerialized: | |
| _host = None | |
| _collection_formats: Dict[str, str] = { | |
| } | |
| _path_params: Dict[str, str] = {} | |
| _query_params: List[Tuple[str, str]] = [] | |
| _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) | |
| _form_params: List[Tuple[str, str]] = [] | |
| _files: Dict[ | |
| str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] | |
| ] = {} | |
| _body_params: Optional[bytes] = None | |
| # process the path parameters | |
| if bundle_name is not None: | |
| _path_params['bundle_name'] = bundle_name | |
| # process the query parameters | |
| if limit is not None: | |
| _query_params.append(('limit', limit)) | |
| if offset is not None: | |
| _query_params.append(('offset', offset)) | |
| # process the header parameters | |
| # process the form parameters | |
| # process the body parameter | |
| # set the HTTP header `Accept` | |
| if not any(key.lower() == 'accept' for key in _header_params): | |
| _header_params['Accept'] = self.api_client.select_header_accept( | |
| [ | |
| 'application/json' | |
| ] | |
| ) | |
| # authentication setting | |
| _auth_settings: List[str] = [ | |
| 'OAuth2PasswordBearer', | |
| 'HTTPBearer' | |
| ] | |
| return self.api_client.param_serialize( | |
| method='GET', | |
| resource_path='/api/v2/dagBundles/{bundle_name}/files', | |
| path_params=_path_params, | |
| query_params=_query_params, | |
| header_params=_header_params, | |
| body=_body_params, | |
| post_params=_form_params, | |
| files=_files, | |
| auth_settings=_auth_settings, | |
| collection_formats=_collection_formats, | |
| _host=_host, | |
| _request_auth=_request_auth | |
| ) | |
| @validate_call | |
| def get_dag_bundles( | |
| self, | |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| order_by: Annotated[Optional[List[StrictStr]], Field(description="Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name, version, last_refreshed, active`")] = None, | |
| _request_timeout: Union[ | |
| None, | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Tuple[ | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Annotated[StrictFloat, Field(gt=0)] | |
| ] | |
| ] = None, | |
| _request_auth: Optional[Dict[StrictStr, Any]] = None, | |
| _content_type: Optional[StrictStr] = None, | |
| _headers: Optional[Dict[StrictStr, Any]] = None, | |
| _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, | |
| ) -> DagBundleCollectionResponse: | |
| """Get Dag Bundles | |
| List the Dag bundles Airflow knows about. Reports the version of each bundle Airflow currently holds and when a Dag processor last refreshed it, so whoever deployed the code can tell whether it has been picked up yet. A bundle is visible to a user who can read at least one Dag recorded against it. A bundle holding no registered Dag at all has nothing to authorize against, so it is listed only for a user holding the admin-by-default ``AccessView.IMPORT_ERRORS_ALL`` for that bundle's team -- the same view, scoped the same way, that governs import errors for a file that never registered a Dag. | |
| :param limit: | |
| :type limit: int | |
| :param offset: | |
| :type offset: int | |
| :param order_by: Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name, version, last_refreshed, active` | |
| :type order_by: List[str] | |
| :param _request_timeout: timeout setting for this request. If one | |
| number provided, it will be total request | |
| timeout. It can also be a pair (tuple) of | |
| (connection, read) timeouts. | |
| :type _request_timeout: int, tuple(int, int), optional | |
| :param _request_auth: set to override the auth_settings for an a single | |
| request; this effectively ignores the | |
| authentication in the spec for a single request. | |
| :type _request_auth: dict, optional | |
| :param _content_type: force content-type for the request. | |
| :type _content_type: str, Optional | |
| :param _headers: set to override the headers for a single | |
| request; this effectively ignores the headers | |
| in the spec for a single request. | |
| :type _headers: dict, optional | |
| :param _host_index: set to override the host_index for a single | |
| request; this effectively ignores the host_index | |
| in the spec for a single request. | |
| :type _host_index: int, optional | |
| :return: Returns the result object. | |
| """ # noqa: E501 | |
| _param = self._get_dag_bundles_serialize( | |
| limit=limit, | |
| offset=offset, | |
| order_by=order_by, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "DagBundleCollectionResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| response_data.read() | |
| return self.api_client.response_deserialize( | |
| response_data=response_data, | |
| response_types_map=_response_types_map, | |
| ).data | |
| @validate_call | |
| def get_dag_bundles_with_http_info( | |
| self, | |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| order_by: Annotated[Optional[List[StrictStr]], Field(description="Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name, version, last_refreshed, active`")] = None, | |
| _request_timeout: Union[ | |
| None, | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Tuple[ | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Annotated[StrictFloat, Field(gt=0)] | |
| ] | |
| ] = None, | |
| _request_auth: Optional[Dict[StrictStr, Any]] = None, | |
| _content_type: Optional[StrictStr] = None, | |
| _headers: Optional[Dict[StrictStr, Any]] = None, | |
| _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, | |
| ) -> ApiResponse[DagBundleCollectionResponse]: | |
| """Get Dag Bundles | |
| List the Dag bundles Airflow knows about. Reports the version of each bundle Airflow currently holds and when a Dag processor last refreshed it, so whoever deployed the code can tell whether it has been picked up yet. A bundle is visible to a user who can read at least one Dag recorded against it. A bundle holding no registered Dag at all has nothing to authorize against, so it is listed only for a user holding the admin-by-default ``AccessView.IMPORT_ERRORS_ALL`` for that bundle's team -- the same view, scoped the same way, that governs import errors for a file that never registered a Dag. | |
| :param limit: | |
| :type limit: int | |
| :param offset: | |
| :type offset: int | |
| :param order_by: Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name, version, last_refreshed, active` | |
| :type order_by: List[str] | |
| :param _request_timeout: timeout setting for this request. If one | |
| number provided, it will be total request | |
| timeout. It can also be a pair (tuple) of | |
| (connection, read) timeouts. | |
| :type _request_timeout: int, tuple(int, int), optional | |
| :param _request_auth: set to override the auth_settings for an a single | |
| request; this effectively ignores the | |
| authentication in the spec for a single request. | |
| :type _request_auth: dict, optional | |
| :param _content_type: force content-type for the request. | |
| :type _content_type: str, Optional | |
| :param _headers: set to override the headers for a single | |
| request; this effectively ignores the headers | |
| in the spec for a single request. | |
| :type _headers: dict, optional | |
| :param _host_index: set to override the host_index for a single | |
| request; this effectively ignores the host_index | |
| in the spec for a single request. | |
| :type _host_index: int, optional | |
| :return: Returns the result object. | |
| """ # noqa: E501 | |
| _param = self._get_dag_bundles_serialize( | |
| limit=limit, | |
| offset=offset, | |
| order_by=order_by, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "DagBundleCollectionResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| response_data.read() | |
| return self.api_client.response_deserialize( | |
| response_data=response_data, | |
| response_types_map=_response_types_map, | |
| ) | |
| @validate_call | |
| def get_dag_bundles_without_preload_content( | |
| self, | |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| order_by: Annotated[Optional[List[StrictStr]], Field(description="Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name, version, last_refreshed, active`")] = None, | |
| _request_timeout: Union[ | |
| None, | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Tuple[ | |
| Annotated[StrictFloat, Field(gt=0)], | |
| Annotated[StrictFloat, Field(gt=0)] | |
| ] | |
| ] = None, | |
| _request_auth: Optional[Dict[StrictStr, Any]] = None, | |
| _content_type: Optional[StrictStr] = None, | |
| _headers: Optional[Dict[StrictStr, Any]] = None, | |
| _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, | |
| ) -> RESTResponseType: | |
| """Get Dag Bundles | |
| List the Dag bundles Airflow knows about. Reports the version of each bundle Airflow currently holds and when a Dag processor last refreshed it, so whoever deployed the code can tell whether it has been picked up yet. A bundle is visible to a user who can read at least one Dag recorded against it. A bundle holding no registered Dag at all has nothing to authorize against, so it is listed only for a user holding the admin-by-default ``AccessView.IMPORT_ERRORS_ALL`` for that bundle's team -- the same view, scoped the same way, that governs import errors for a file that never registered a Dag. | |
| :param limit: | |
| :type limit: int | |
| :param offset: | |
| :type offset: int | |
| :param order_by: Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `name, version, last_refreshed, active` | |
| :type order_by: List[str] | |
| :param _request_timeout: timeout setting for this request. If one | |
| number provided, it will be total request | |
| timeout. It can also be a pair (tuple) of | |
| (connection, read) timeouts. | |
| :type _request_timeout: int, tuple(int, int), optional | |
| :param _request_auth: set to override the auth_settings for an a single | |
| request; this effectively ignores the | |
| authentication in the spec for a single request. | |
| :type _request_auth: dict, optional | |
| :param _content_type: force content-type for the request. | |
| :type _content_type: str, Optional | |
| :param _headers: set to override the headers for a single | |
| request; this effectively ignores the headers | |
| in the spec for a single request. | |
| :type _headers: dict, optional | |
| :param _host_index: set to override the host_index for a single | |
| request; this effectively ignores the host_index | |
| in the spec for a single request. | |
| :type _host_index: int, optional | |
| :return: Returns the result object. | |
| """ # noqa: E501 | |
| _param = self._get_dag_bundles_serialize( | |
| limit=limit, | |
| offset=offset, | |
| order_by=order_by, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "DagBundleCollectionResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| return response_data.response | |
| def _get_dag_bundles_serialize( | |
| self, | |
| limit, | |
| offset, | |
| order_by, | |
| _request_auth, | |
| _content_type, | |
| _headers, | |
| _host_index, | |
| ) -> RequestSerialized: | |
| _host = None | |
| _collection_formats: Dict[str, str] = { | |
| 'order_by': 'multi', | |
| } | |
| _path_params: Dict[str, str] = {} | |
| _query_params: List[Tuple[str, str]] = [] | |
| _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) | |
| _form_params: List[Tuple[str, str]] = [] | |
| _files: Dict[ | |
| str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] | |
| ] = {} | |
| _body_params: Optional[bytes] = None | |
| # process the path parameters | |
| # process the query parameters | |
| if limit is not None: | |
| _query_params.append(('limit', limit)) | |
| if offset is not None: | |
| _query_params.append(('offset', offset)) | |
| if order_by is not None: | |
| _query_params.append(('order_by', order_by)) | |
| # process the header parameters | |
| # process the form parameters | |
| # process the body parameter | |
| # set the HTTP header `Accept` | |
| if not any(key.lower() == 'accept' for key in _header_params): | |
| _header_params['Accept'] = self.api_client.select_header_accept( | |
| [ | |
| 'application/json' | |
| ] | |
| ) | |
| # authentication setting | |
| _auth_settings: List[str] = [ | |
| 'OAuth2PasswordBearer', | |
| 'HTTPBearer' | |
| ] | |
| return self.api_client.param_serialize( | |
| method='GET', | |
| resource_path='/api/v2/dagBundles', | |
| path_params=_path_params, | |
| query_params=_query_params, | |
| header_params=_header_params, | |
| body=_body_params, | |
| post_params=_form_params, | |
| files=_files, | |
| auth_settings=_auth_settings, | |
| collection_formats=_collection_formats, | |
| _host=_host, | |
| _request_auth=_request_auth | |
| ) | |