blob: 9115145370337f91f8916ec213b3c20bba06e095 [file]
"""
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 datetime import date, datetime
from pydantic import Field, StrictFloat, StrictInt, StrictStr, field_validator
from typing import Any, List, Optional, Union
from typing_extensions import Annotated
from airflow_client.client.models.asset_event_collection_response import AssetEventCollectionResponse
from airflow_client.client.models.bulk_body_bulk_dag_run_body import BulkBodyBulkDAGRunBody
from airflow_client.client.models.bulk_dag_run_clear_body import BulkDAGRunClearBody
from airflow_client.client.models.bulk_response import BulkResponse
from airflow_client.client.models.clear_partitions_body import ClearPartitionsBody
from airflow_client.client.models.clear_partitions_response import ClearPartitionsResponse
from airflow_client.client.models.dag_run_clear_body import DAGRunClearBody
from airflow_client.client.models.dag_run_collection_response import DAGRunCollectionResponse
from airflow_client.client.models.dag_run_patch_body import DAGRunPatchBody
from airflow_client.client.models.dag_run_response import DAGRunResponse
from airflow_client.client.models.dag_runs_batch_body import DAGRunsBatchBody
from airflow_client.client.models.response_clear_dag_run import ResponseClearDagRun
from airflow_client.client.models.response_clear_dag_runs import ResponseClearDagRuns
from airflow_client.client.models.trigger_dag_run_post_body import TriggerDAGRunPostBody
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 DagRunApi:
"""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 bulk_dag_runs(
self,
dag_id: StrictStr,
bulk_body_bulk_dag_run_body: BulkBodyBulkDAGRunBody,
_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,
) -> BulkResponse:
"""Bulk Dag Runs
Bulk update or delete Dag Runs.
:param dag_id: (required)
:type dag_id: str
:param bulk_body_bulk_dag_run_body: (required)
:type bulk_body_bulk_dag_run_body: BulkBodyBulkDAGRunBody
: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._bulk_dag_runs_serialize(
dag_id=dag_id,
bulk_body_bulk_dag_run_body=bulk_body_bulk_dag_run_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "BulkResponse",
'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 bulk_dag_runs_with_http_info(
self,
dag_id: StrictStr,
bulk_body_bulk_dag_run_body: BulkBodyBulkDAGRunBody,
_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[BulkResponse]:
"""Bulk Dag Runs
Bulk update or delete Dag Runs.
:param dag_id: (required)
:type dag_id: str
:param bulk_body_bulk_dag_run_body: (required)
:type bulk_body_bulk_dag_run_body: BulkBodyBulkDAGRunBody
: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._bulk_dag_runs_serialize(
dag_id=dag_id,
bulk_body_bulk_dag_run_body=bulk_body_bulk_dag_run_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "BulkResponse",
'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 bulk_dag_runs_without_preload_content(
self,
dag_id: StrictStr,
bulk_body_bulk_dag_run_body: BulkBodyBulkDAGRunBody,
_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:
"""Bulk Dag Runs
Bulk update or delete Dag Runs.
:param dag_id: (required)
:type dag_id: str
:param bulk_body_bulk_dag_run_body: (required)
:type bulk_body_bulk_dag_run_body: BulkBodyBulkDAGRunBody
: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._bulk_dag_runs_serialize(
dag_id=dag_id,
bulk_body_bulk_dag_run_body=bulk_body_bulk_dag_run_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "BulkResponse",
'401': "HTTPExceptionResponse",
'403': "HTTPExceptionResponse",
'422': "HTTPValidationError",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _bulk_dag_runs_serialize(
self,
dag_id,
bulk_body_bulk_dag_run_body,
_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, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if bulk_body_bulk_dag_run_body is not None:
_body_params = bulk_body_bulk_dag_run_body
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'OAuth2PasswordBearer',
'HTTPBearer'
]
return self.api_client.param_serialize(
method='PATCH',
resource_path='/api/v2/dags/{dag_id}/dagRuns',
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 clear_dag_run(
self,
dag_id: StrictStr,
dag_run_id: StrictStr,
dag_run_clear_body: DAGRunClearBody,
_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,
) -> ResponseClearDagRun:
"""Clear Dag Run
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: str
:param dag_run_clear_body: (required)
:type dag_run_clear_body: DAGRunClearBody
: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._clear_dag_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
dag_run_clear_body=dag_run_clear_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "ResponseClearDagRun",
'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 clear_dag_run_with_http_info(
self,
dag_id: StrictStr,
dag_run_id: StrictStr,
dag_run_clear_body: DAGRunClearBody,
_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[ResponseClearDagRun]:
"""Clear Dag Run
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: str
:param dag_run_clear_body: (required)
:type dag_run_clear_body: DAGRunClearBody
: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._clear_dag_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
dag_run_clear_body=dag_run_clear_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "ResponseClearDagRun",
'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 clear_dag_run_without_preload_content(
self,
dag_id: StrictStr,
dag_run_id: StrictStr,
dag_run_clear_body: DAGRunClearBody,
_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:
"""Clear Dag Run
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: str
:param dag_run_clear_body: (required)
:type dag_run_clear_body: DAGRunClearBody
: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._clear_dag_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
dag_run_clear_body=dag_run_clear_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "ResponseClearDagRun",
'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 _clear_dag_run_serialize(
self,
dag_id,
dag_run_id,
dag_run_clear_body,
_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, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
if dag_run_id is not None:
_path_params['dag_run_id'] = dag_run_id
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if dag_run_clear_body is not None:
_body_params = dag_run_clear_body
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'OAuth2PasswordBearer',
'HTTPBearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear',
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 clear_dag_run_partitions(
self,
dag_id: StrictStr,
clear_partitions_body: ClearPartitionsBody,
_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,
) -> ClearPartitionsResponse:
"""Clear Dag Run Partitions
Reset partition_key and partition_date fields on matching Dag Runs.
:param dag_id: (required)
:type dag_id: str
:param clear_partitions_body: (required)
:type clear_partitions_body: ClearPartitionsBody
: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._clear_dag_run_partitions_serialize(
dag_id=dag_id,
clear_partitions_body=clear_partitions_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "ClearPartitionsResponse",
'400': "HTTPExceptionResponse",
'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 clear_dag_run_partitions_with_http_info(
self,
dag_id: StrictStr,
clear_partitions_body: ClearPartitionsBody,
_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[ClearPartitionsResponse]:
"""Clear Dag Run Partitions
Reset partition_key and partition_date fields on matching Dag Runs.
:param dag_id: (required)
:type dag_id: str
:param clear_partitions_body: (required)
:type clear_partitions_body: ClearPartitionsBody
: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._clear_dag_run_partitions_serialize(
dag_id=dag_id,
clear_partitions_body=clear_partitions_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "ClearPartitionsResponse",
'400': "HTTPExceptionResponse",
'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 clear_dag_run_partitions_without_preload_content(
self,
dag_id: StrictStr,
clear_partitions_body: ClearPartitionsBody,
_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:
"""Clear Dag Run Partitions
Reset partition_key and partition_date fields on matching Dag Runs.
:param dag_id: (required)
:type dag_id: str
:param clear_partitions_body: (required)
:type clear_partitions_body: ClearPartitionsBody
: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._clear_dag_run_partitions_serialize(
dag_id=dag_id,
clear_partitions_body=clear_partitions_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "ClearPartitionsResponse",
'400': "HTTPExceptionResponse",
'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 _clear_dag_run_partitions_serialize(
self,
dag_id,
clear_partitions_body,
_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, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if clear_partitions_body is not None:
_body_params = clear_partitions_body
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'OAuth2PasswordBearer',
'HTTPBearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/api/v2/dags/{dag_id}/clearPartitions',
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 clear_dag_runs(
self,
dag_id: StrictStr,
bulk_dag_run_clear_body: BulkDAGRunClearBody,
_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,
) -> ResponseClearDagRuns:
"""Clear Dag Runs
Clear multiple Dag Runs in a single request.
:param dag_id: (required)
:type dag_id: str
:param bulk_dag_run_clear_body: (required)
:type bulk_dag_run_clear_body: BulkDAGRunClearBody
: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._clear_dag_runs_serialize(
dag_id=dag_id,
bulk_dag_run_clear_body=bulk_dag_run_clear_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "ResponseClearDagRuns",
'400': "HTTPExceptionResponse",
'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 clear_dag_runs_with_http_info(
self,
dag_id: StrictStr,
bulk_dag_run_clear_body: BulkDAGRunClearBody,
_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[ResponseClearDagRuns]:
"""Clear Dag Runs
Clear multiple Dag Runs in a single request.
:param dag_id: (required)
:type dag_id: str
:param bulk_dag_run_clear_body: (required)
:type bulk_dag_run_clear_body: BulkDAGRunClearBody
: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._clear_dag_runs_serialize(
dag_id=dag_id,
bulk_dag_run_clear_body=bulk_dag_run_clear_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "ResponseClearDagRuns",
'400': "HTTPExceptionResponse",
'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 clear_dag_runs_without_preload_content(
self,
dag_id: StrictStr,
bulk_dag_run_clear_body: BulkDAGRunClearBody,
_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:
"""Clear Dag Runs
Clear multiple Dag Runs in a single request.
:param dag_id: (required)
:type dag_id: str
:param bulk_dag_run_clear_body: (required)
:type bulk_dag_run_clear_body: BulkDAGRunClearBody
: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._clear_dag_runs_serialize(
dag_id=dag_id,
bulk_dag_run_clear_body=bulk_dag_run_clear_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "ResponseClearDagRuns",
'400': "HTTPExceptionResponse",
'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 _clear_dag_runs_serialize(
self,
dag_id,
bulk_dag_run_clear_body,
_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, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if bulk_dag_run_clear_body is not None:
_body_params = bulk_dag_run_clear_body
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'OAuth2PasswordBearer',
'HTTPBearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/api/v2/dags/{dag_id}/clearDagRuns',
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 delete_dag_run(
self,
dag_id: StrictStr,
dag_run_id: 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,
) -> None:
"""Delete Dag Run
Delete a Dag Run entry.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: 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._delete_dag_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'204': None,
'400': "HTTPExceptionResponse",
'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 delete_dag_run_with_http_info(
self,
dag_id: StrictStr,
dag_run_id: 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[None]:
"""Delete Dag Run
Delete a Dag Run entry.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: 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._delete_dag_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'204': None,
'400': "HTTPExceptionResponse",
'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 delete_dag_run_without_preload_content(
self,
dag_id: StrictStr,
dag_run_id: 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:
"""Delete Dag Run
Delete a Dag Run entry.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: 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._delete_dag_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'204': None,
'400': "HTTPExceptionResponse",
'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 _delete_dag_run_serialize(
self,
dag_id,
dag_run_id,
_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, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
if dag_run_id is not None:
_path_params['dag_run_id'] = dag_run_id
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not 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='DELETE',
resource_path='/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}',
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_run(
self,
dag_id: StrictStr,
dag_run_id: 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,
) -> DAGRunResponse:
"""Get Dag Run
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: 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_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunResponse",
'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_run_with_http_info(
self,
dag_id: StrictStr,
dag_run_id: 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[DAGRunResponse]:
"""Get Dag Run
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: 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_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunResponse",
'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_run_without_preload_content(
self,
dag_id: StrictStr,
dag_run_id: 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 Run
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: 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_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunResponse",
'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_run_serialize(
self,
dag_id,
dag_run_id,
_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, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
if dag_run_id is not None:
_path_params['dag_run_id'] = dag_run_id
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not 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/dags/{dag_id}/dagRuns/{dag_run_id}',
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_runs(
self,
dag_id: StrictStr,
partition_date_gte: Annotated[Optional[date], Field(description="Inclusive lower bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. Runs from the start of this day onwards match.")] = None,
partition_date_lte: Annotated[Optional[date], Field(description="Inclusive upper bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. The whole day is included: runs up to the end of this day match.")] = None,
cursor: Annotated[Optional[StrictStr], Field(description="Cursor for keyset-based pagination. Pass an empty string for the first page, then use ``next_cursor`` from the response. When ``cursor`` is provided, ``offset`` is ignored.")] = None,
limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
run_after_gte: Optional[datetime] = None,
run_after_gt: Optional[datetime] = None,
run_after_lte: Optional[datetime] = None,
run_after_lt: Optional[datetime] = None,
logical_date_gte: Optional[datetime] = None,
logical_date_gt: Optional[datetime] = None,
logical_date_lte: Optional[datetime] = None,
logical_date_lt: Optional[datetime] = None,
start_date_gte: Optional[datetime] = None,
start_date_gt: Optional[datetime] = None,
start_date_lte: Optional[datetime] = None,
start_date_lt: Optional[datetime] = None,
end_date_gte: Optional[datetime] = None,
end_date_gt: Optional[datetime] = None,
end_date_lte: Optional[datetime] = None,
end_date_lt: Optional[datetime] = None,
duration_gte: Optional[Union[StrictFloat, StrictInt]] = None,
duration_gt: Optional[Union[StrictFloat, StrictInt]] = None,
duration_lte: Optional[Union[StrictFloat, StrictInt]] = None,
duration_lt: Optional[Union[StrictFloat, StrictInt]] = None,
updated_at_gte: Optional[datetime] = None,
updated_at_gt: Optional[datetime] = None,
updated_at_lte: Optional[datetime] = None,
updated_at_lt: Optional[datetime] = None,
conf_contains: Optional[StrictStr] = None,
run_type: Optional[List[StrictStr]] = None,
state: Optional[List[StrictStr]] = None,
dag_version: Optional[List[StrictInt]] = None,
bundle_version: Optional[StrictStr] = 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: `id, state, dag_id, run_id, logical_date, partition_date, run_after, start_date, end_date, updated_at, conf, duration, dag_run_id`")] = None,
run_id_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `run_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
run_id_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = None,
triggering_user_name_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `triggering_user_name_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
triggering_user_name_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = None,
dag_id_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `dag_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
dag_id_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = None,
partition_key_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Here `|` is matched literally, not as OR. Slower than `partition_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
partition_key_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. Here `|` is matched literally, not as OR. See \"Filtering with pattern parameters\".")] = None,
consuming_asset_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match against the consuming asset name or URI. Unlike the wildcard `*_pattern` parameters, `%` and `_` are matched literally, `|` is not an OR separator, and `~` does not match everything.")] = 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,
) -> DAGRunCollectionResponse:
"""Get Dag Runs
Get all Dag Runs. This endpoint allows specifying `~` as the dag_id to retrieve Dag Runs for all Dags. Supports two pagination modes: **Offset (default):** use `limit` and `offset` query parameters. Returns `total_entries`. **Cursor:** pass `cursor` (empty string for the first page, then `next_cursor` from the response). When `cursor` is provided, `offset` is ignored and `total_entries` is not returned. ``next_cursor`` is ``null`` when there are no more pages; ``previous_cursor`` is ``null`` on the first page.
:param dag_id: (required)
:type dag_id: str
:param partition_date_gte: Inclusive lower bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. Runs from the start of this day onwards match.
:type partition_date_gte: date
:param partition_date_lte: Inclusive upper bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. The whole day is included: runs up to the end of this day match.
:type partition_date_lte: date
:param cursor: Cursor for keyset-based pagination. Pass an empty string for the first page, then use ``next_cursor`` from the response. When ``cursor`` is provided, ``offset`` is ignored.
:type cursor: str
:param limit:
:type limit: int
:param offset:
:type offset: int
:param run_after_gte:
:type run_after_gte: datetime
:param run_after_gt:
:type run_after_gt: datetime
:param run_after_lte:
:type run_after_lte: datetime
:param run_after_lt:
:type run_after_lt: datetime
:param logical_date_gte:
:type logical_date_gte: datetime
:param logical_date_gt:
:type logical_date_gt: datetime
:param logical_date_lte:
:type logical_date_lte: datetime
:param logical_date_lt:
:type logical_date_lt: datetime
:param start_date_gte:
:type start_date_gte: datetime
:param start_date_gt:
:type start_date_gt: datetime
:param start_date_lte:
:type start_date_lte: datetime
:param start_date_lt:
:type start_date_lt: datetime
:param end_date_gte:
:type end_date_gte: datetime
:param end_date_gt:
:type end_date_gt: datetime
:param end_date_lte:
:type end_date_lte: datetime
:param end_date_lt:
:type end_date_lt: datetime
:param duration_gte:
:type duration_gte: float
:param duration_gt:
:type duration_gt: float
:param duration_lte:
:type duration_lte: float
:param duration_lt:
:type duration_lt: float
:param updated_at_gte:
:type updated_at_gte: datetime
:param updated_at_gt:
:type updated_at_gt: datetime
:param updated_at_lte:
:type updated_at_lte: datetime
:param updated_at_lt:
:type updated_at_lt: datetime
:param conf_contains:
:type conf_contains: str
:param run_type:
:type run_type: List[str]
:param state:
:type state: List[str]
:param dag_version:
:type dag_version: List[int]
:param bundle_version:
:type bundle_version: str
:param order_by: Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, partition_date, run_after, start_date, end_date, updated_at, conf, duration, dag_run_id`
:type order_by: List[str]
:param run_id_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `run_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type run_id_pattern: str
:param run_id_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".
:type run_id_prefix_pattern: str
:param triggering_user_name_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `triggering_user_name_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type triggering_user_name_pattern: str
:param triggering_user_name_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".
:type triggering_user_name_prefix_pattern: str
:param dag_id_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `dag_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type dag_id_pattern: str
:param dag_id_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".
:type dag_id_prefix_pattern: str
:param partition_key_pattern: Case-insensitive substring match (SQL `ILIKE`). Here `|` is matched literally, not as OR. Slower than `partition_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type partition_key_pattern: str
:param partition_key_prefix_pattern: Case-sensitive, index-friendly prefix match. Here `|` is matched literally, not as OR. See \"Filtering with pattern parameters\".
:type partition_key_prefix_pattern: str
:param consuming_asset_pattern: Case-insensitive substring match against the consuming asset name or URI. Unlike the wildcard `*_pattern` parameters, `%` and `_` are matched literally, `|` is not an OR separator, and `~` does not match everything.
:type consuming_asset_pattern: 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_runs_serialize(
dag_id=dag_id,
partition_date_gte=partition_date_gte,
partition_date_lte=partition_date_lte,
cursor=cursor,
limit=limit,
offset=offset,
run_after_gte=run_after_gte,
run_after_gt=run_after_gt,
run_after_lte=run_after_lte,
run_after_lt=run_after_lt,
logical_date_gte=logical_date_gte,
logical_date_gt=logical_date_gt,
logical_date_lte=logical_date_lte,
logical_date_lt=logical_date_lt,
start_date_gte=start_date_gte,
start_date_gt=start_date_gt,
start_date_lte=start_date_lte,
start_date_lt=start_date_lt,
end_date_gte=end_date_gte,
end_date_gt=end_date_gt,
end_date_lte=end_date_lte,
end_date_lt=end_date_lt,
duration_gte=duration_gte,
duration_gt=duration_gt,
duration_lte=duration_lte,
duration_lt=duration_lt,
updated_at_gte=updated_at_gte,
updated_at_gt=updated_at_gt,
updated_at_lte=updated_at_lte,
updated_at_lt=updated_at_lt,
conf_contains=conf_contains,
run_type=run_type,
state=state,
dag_version=dag_version,
bundle_version=bundle_version,
order_by=order_by,
run_id_pattern=run_id_pattern,
run_id_prefix_pattern=run_id_prefix_pattern,
triggering_user_name_pattern=triggering_user_name_pattern,
triggering_user_name_prefix_pattern=triggering_user_name_prefix_pattern,
dag_id_pattern=dag_id_pattern,
dag_id_prefix_pattern=dag_id_prefix_pattern,
partition_key_pattern=partition_key_pattern,
partition_key_prefix_pattern=partition_key_prefix_pattern,
consuming_asset_pattern=consuming_asset_pattern,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunCollectionResponse",
'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_runs_with_http_info(
self,
dag_id: StrictStr,
partition_date_gte: Annotated[Optional[date], Field(description="Inclusive lower bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. Runs from the start of this day onwards match.")] = None,
partition_date_lte: Annotated[Optional[date], Field(description="Inclusive upper bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. The whole day is included: runs up to the end of this day match.")] = None,
cursor: Annotated[Optional[StrictStr], Field(description="Cursor for keyset-based pagination. Pass an empty string for the first page, then use ``next_cursor`` from the response. When ``cursor`` is provided, ``offset`` is ignored.")] = None,
limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
run_after_gte: Optional[datetime] = None,
run_after_gt: Optional[datetime] = None,
run_after_lte: Optional[datetime] = None,
run_after_lt: Optional[datetime] = None,
logical_date_gte: Optional[datetime] = None,
logical_date_gt: Optional[datetime] = None,
logical_date_lte: Optional[datetime] = None,
logical_date_lt: Optional[datetime] = None,
start_date_gte: Optional[datetime] = None,
start_date_gt: Optional[datetime] = None,
start_date_lte: Optional[datetime] = None,
start_date_lt: Optional[datetime] = None,
end_date_gte: Optional[datetime] = None,
end_date_gt: Optional[datetime] = None,
end_date_lte: Optional[datetime] = None,
end_date_lt: Optional[datetime] = None,
duration_gte: Optional[Union[StrictFloat, StrictInt]] = None,
duration_gt: Optional[Union[StrictFloat, StrictInt]] = None,
duration_lte: Optional[Union[StrictFloat, StrictInt]] = None,
duration_lt: Optional[Union[StrictFloat, StrictInt]] = None,
updated_at_gte: Optional[datetime] = None,
updated_at_gt: Optional[datetime] = None,
updated_at_lte: Optional[datetime] = None,
updated_at_lt: Optional[datetime] = None,
conf_contains: Optional[StrictStr] = None,
run_type: Optional[List[StrictStr]] = None,
state: Optional[List[StrictStr]] = None,
dag_version: Optional[List[StrictInt]] = None,
bundle_version: Optional[StrictStr] = 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: `id, state, dag_id, run_id, logical_date, partition_date, run_after, start_date, end_date, updated_at, conf, duration, dag_run_id`")] = None,
run_id_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `run_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
run_id_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = None,
triggering_user_name_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `triggering_user_name_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
triggering_user_name_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = None,
dag_id_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `dag_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
dag_id_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = None,
partition_key_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Here `|` is matched literally, not as OR. Slower than `partition_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
partition_key_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. Here `|` is matched literally, not as OR. See \"Filtering with pattern parameters\".")] = None,
consuming_asset_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match against the consuming asset name or URI. Unlike the wildcard `*_pattern` parameters, `%` and `_` are matched literally, `|` is not an OR separator, and `~` does not match everything.")] = 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[DAGRunCollectionResponse]:
"""Get Dag Runs
Get all Dag Runs. This endpoint allows specifying `~` as the dag_id to retrieve Dag Runs for all Dags. Supports two pagination modes: **Offset (default):** use `limit` and `offset` query parameters. Returns `total_entries`. **Cursor:** pass `cursor` (empty string for the first page, then `next_cursor` from the response). When `cursor` is provided, `offset` is ignored and `total_entries` is not returned. ``next_cursor`` is ``null`` when there are no more pages; ``previous_cursor`` is ``null`` on the first page.
:param dag_id: (required)
:type dag_id: str
:param partition_date_gte: Inclusive lower bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. Runs from the start of this day onwards match.
:type partition_date_gte: date
:param partition_date_lte: Inclusive upper bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. The whole day is included: runs up to the end of this day match.
:type partition_date_lte: date
:param cursor: Cursor for keyset-based pagination. Pass an empty string for the first page, then use ``next_cursor`` from the response. When ``cursor`` is provided, ``offset`` is ignored.
:type cursor: str
:param limit:
:type limit: int
:param offset:
:type offset: int
:param run_after_gte:
:type run_after_gte: datetime
:param run_after_gt:
:type run_after_gt: datetime
:param run_after_lte:
:type run_after_lte: datetime
:param run_after_lt:
:type run_after_lt: datetime
:param logical_date_gte:
:type logical_date_gte: datetime
:param logical_date_gt:
:type logical_date_gt: datetime
:param logical_date_lte:
:type logical_date_lte: datetime
:param logical_date_lt:
:type logical_date_lt: datetime
:param start_date_gte:
:type start_date_gte: datetime
:param start_date_gt:
:type start_date_gt: datetime
:param start_date_lte:
:type start_date_lte: datetime
:param start_date_lt:
:type start_date_lt: datetime
:param end_date_gte:
:type end_date_gte: datetime
:param end_date_gt:
:type end_date_gt: datetime
:param end_date_lte:
:type end_date_lte: datetime
:param end_date_lt:
:type end_date_lt: datetime
:param duration_gte:
:type duration_gte: float
:param duration_gt:
:type duration_gt: float
:param duration_lte:
:type duration_lte: float
:param duration_lt:
:type duration_lt: float
:param updated_at_gte:
:type updated_at_gte: datetime
:param updated_at_gt:
:type updated_at_gt: datetime
:param updated_at_lte:
:type updated_at_lte: datetime
:param updated_at_lt:
:type updated_at_lt: datetime
:param conf_contains:
:type conf_contains: str
:param run_type:
:type run_type: List[str]
:param state:
:type state: List[str]
:param dag_version:
:type dag_version: List[int]
:param bundle_version:
:type bundle_version: str
:param order_by: Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, partition_date, run_after, start_date, end_date, updated_at, conf, duration, dag_run_id`
:type order_by: List[str]
:param run_id_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `run_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type run_id_pattern: str
:param run_id_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".
:type run_id_prefix_pattern: str
:param triggering_user_name_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `triggering_user_name_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type triggering_user_name_pattern: str
:param triggering_user_name_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".
:type triggering_user_name_prefix_pattern: str
:param dag_id_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `dag_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type dag_id_pattern: str
:param dag_id_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".
:type dag_id_prefix_pattern: str
:param partition_key_pattern: Case-insensitive substring match (SQL `ILIKE`). Here `|` is matched literally, not as OR. Slower than `partition_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type partition_key_pattern: str
:param partition_key_prefix_pattern: Case-sensitive, index-friendly prefix match. Here `|` is matched literally, not as OR. See \"Filtering with pattern parameters\".
:type partition_key_prefix_pattern: str
:param consuming_asset_pattern: Case-insensitive substring match against the consuming asset name or URI. Unlike the wildcard `*_pattern` parameters, `%` and `_` are matched literally, `|` is not an OR separator, and `~` does not match everything.
:type consuming_asset_pattern: 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_runs_serialize(
dag_id=dag_id,
partition_date_gte=partition_date_gte,
partition_date_lte=partition_date_lte,
cursor=cursor,
limit=limit,
offset=offset,
run_after_gte=run_after_gte,
run_after_gt=run_after_gt,
run_after_lte=run_after_lte,
run_after_lt=run_after_lt,
logical_date_gte=logical_date_gte,
logical_date_gt=logical_date_gt,
logical_date_lte=logical_date_lte,
logical_date_lt=logical_date_lt,
start_date_gte=start_date_gte,
start_date_gt=start_date_gt,
start_date_lte=start_date_lte,
start_date_lt=start_date_lt,
end_date_gte=end_date_gte,
end_date_gt=end_date_gt,
end_date_lte=end_date_lte,
end_date_lt=end_date_lt,
duration_gte=duration_gte,
duration_gt=duration_gt,
duration_lte=duration_lte,
duration_lt=duration_lt,
updated_at_gte=updated_at_gte,
updated_at_gt=updated_at_gt,
updated_at_lte=updated_at_lte,
updated_at_lt=updated_at_lt,
conf_contains=conf_contains,
run_type=run_type,
state=state,
dag_version=dag_version,
bundle_version=bundle_version,
order_by=order_by,
run_id_pattern=run_id_pattern,
run_id_prefix_pattern=run_id_prefix_pattern,
triggering_user_name_pattern=triggering_user_name_pattern,
triggering_user_name_prefix_pattern=triggering_user_name_prefix_pattern,
dag_id_pattern=dag_id_pattern,
dag_id_prefix_pattern=dag_id_prefix_pattern,
partition_key_pattern=partition_key_pattern,
partition_key_prefix_pattern=partition_key_prefix_pattern,
consuming_asset_pattern=consuming_asset_pattern,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunCollectionResponse",
'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_runs_without_preload_content(
self,
dag_id: StrictStr,
partition_date_gte: Annotated[Optional[date], Field(description="Inclusive lower bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. Runs from the start of this day onwards match.")] = None,
partition_date_lte: Annotated[Optional[date], Field(description="Inclusive upper bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. The whole day is included: runs up to the end of this day match.")] = None,
cursor: Annotated[Optional[StrictStr], Field(description="Cursor for keyset-based pagination. Pass an empty string for the first page, then use ``next_cursor`` from the response. When ``cursor`` is provided, ``offset`` is ignored.")] = None,
limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None,
run_after_gte: Optional[datetime] = None,
run_after_gt: Optional[datetime] = None,
run_after_lte: Optional[datetime] = None,
run_after_lt: Optional[datetime] = None,
logical_date_gte: Optional[datetime] = None,
logical_date_gt: Optional[datetime] = None,
logical_date_lte: Optional[datetime] = None,
logical_date_lt: Optional[datetime] = None,
start_date_gte: Optional[datetime] = None,
start_date_gt: Optional[datetime] = None,
start_date_lte: Optional[datetime] = None,
start_date_lt: Optional[datetime] = None,
end_date_gte: Optional[datetime] = None,
end_date_gt: Optional[datetime] = None,
end_date_lte: Optional[datetime] = None,
end_date_lt: Optional[datetime] = None,
duration_gte: Optional[Union[StrictFloat, StrictInt]] = None,
duration_gt: Optional[Union[StrictFloat, StrictInt]] = None,
duration_lte: Optional[Union[StrictFloat, StrictInt]] = None,
duration_lt: Optional[Union[StrictFloat, StrictInt]] = None,
updated_at_gte: Optional[datetime] = None,
updated_at_gt: Optional[datetime] = None,
updated_at_lte: Optional[datetime] = None,
updated_at_lt: Optional[datetime] = None,
conf_contains: Optional[StrictStr] = None,
run_type: Optional[List[StrictStr]] = None,
state: Optional[List[StrictStr]] = None,
dag_version: Optional[List[StrictInt]] = None,
bundle_version: Optional[StrictStr] = 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: `id, state, dag_id, run_id, logical_date, partition_date, run_after, start_date, end_date, updated_at, conf, duration, dag_run_id`")] = None,
run_id_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `run_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
run_id_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = None,
triggering_user_name_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `triggering_user_name_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
triggering_user_name_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = None,
dag_id_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `dag_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
dag_id_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = None,
partition_key_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Here `|` is matched literally, not as OR. Slower than `partition_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None,
partition_key_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. Here `|` is matched literally, not as OR. See \"Filtering with pattern parameters\".")] = None,
consuming_asset_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match against the consuming asset name or URI. Unlike the wildcard `*_pattern` parameters, `%` and `_` are matched literally, `|` is not an OR separator, and `~` does not match everything.")] = 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 Runs
Get all Dag Runs. This endpoint allows specifying `~` as the dag_id to retrieve Dag Runs for all Dags. Supports two pagination modes: **Offset (default):** use `limit` and `offset` query parameters. Returns `total_entries`. **Cursor:** pass `cursor` (empty string for the first page, then `next_cursor` from the response). When `cursor` is provided, `offset` is ignored and `total_entries` is not returned. ``next_cursor`` is ``null`` when there are no more pages; ``previous_cursor`` is ``null`` on the first page.
:param dag_id: (required)
:type dag_id: str
:param partition_date_gte: Inclusive lower bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. Runs from the start of this day onwards match.
:type partition_date_gte: date
:param partition_date_lte: Inclusive upper bound of the partition_date window, interpreted as a local calendar day in the Dag's timetable timezone. The whole day is included: runs up to the end of this day match.
:type partition_date_lte: date
:param cursor: Cursor for keyset-based pagination. Pass an empty string for the first page, then use ``next_cursor`` from the response. When ``cursor`` is provided, ``offset`` is ignored.
:type cursor: str
:param limit:
:type limit: int
:param offset:
:type offset: int
:param run_after_gte:
:type run_after_gte: datetime
:param run_after_gt:
:type run_after_gt: datetime
:param run_after_lte:
:type run_after_lte: datetime
:param run_after_lt:
:type run_after_lt: datetime
:param logical_date_gte:
:type logical_date_gte: datetime
:param logical_date_gt:
:type logical_date_gt: datetime
:param logical_date_lte:
:type logical_date_lte: datetime
:param logical_date_lt:
:type logical_date_lt: datetime
:param start_date_gte:
:type start_date_gte: datetime
:param start_date_gt:
:type start_date_gt: datetime
:param start_date_lte:
:type start_date_lte: datetime
:param start_date_lt:
:type start_date_lt: datetime
:param end_date_gte:
:type end_date_gte: datetime
:param end_date_gt:
:type end_date_gt: datetime
:param end_date_lte:
:type end_date_lte: datetime
:param end_date_lt:
:type end_date_lt: datetime
:param duration_gte:
:type duration_gte: float
:param duration_gt:
:type duration_gt: float
:param duration_lte:
:type duration_lte: float
:param duration_lt:
:type duration_lt: float
:param updated_at_gte:
:type updated_at_gte: datetime
:param updated_at_gt:
:type updated_at_gt: datetime
:param updated_at_lte:
:type updated_at_lte: datetime
:param updated_at_lt:
:type updated_at_lt: datetime
:param conf_contains:
:type conf_contains: str
:param run_type:
:type run_type: List[str]
:param state:
:type state: List[str]
:param dag_version:
:type dag_version: List[int]
:param bundle_version:
:type bundle_version: str
:param order_by: Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, state, dag_id, run_id, logical_date, partition_date, run_after, start_date, end_date, updated_at, conf, duration, dag_run_id`
:type order_by: List[str]
:param run_id_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `run_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type run_id_pattern: str
:param run_id_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".
:type run_id_prefix_pattern: str
:param triggering_user_name_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `triggering_user_name_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type triggering_user_name_pattern: str
:param triggering_user_name_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".
:type triggering_user_name_prefix_pattern: str
:param dag_id_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `dag_id_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type dag_id_pattern: str
:param dag_id_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".
:type dag_id_prefix_pattern: str
:param partition_key_pattern: Case-insensitive substring match (SQL `ILIKE`). Here `|` is matched literally, not as OR. Slower than `partition_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".
:type partition_key_pattern: str
:param partition_key_prefix_pattern: Case-sensitive, index-friendly prefix match. Here `|` is matched literally, not as OR. See \"Filtering with pattern parameters\".
:type partition_key_prefix_pattern: str
:param consuming_asset_pattern: Case-insensitive substring match against the consuming asset name or URI. Unlike the wildcard `*_pattern` parameters, `%` and `_` are matched literally, `|` is not an OR separator, and `~` does not match everything.
:type consuming_asset_pattern: 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_runs_serialize(
dag_id=dag_id,
partition_date_gte=partition_date_gte,
partition_date_lte=partition_date_lte,
cursor=cursor,
limit=limit,
offset=offset,
run_after_gte=run_after_gte,
run_after_gt=run_after_gt,
run_after_lte=run_after_lte,
run_after_lt=run_after_lt,
logical_date_gte=logical_date_gte,
logical_date_gt=logical_date_gt,
logical_date_lte=logical_date_lte,
logical_date_lt=logical_date_lt,
start_date_gte=start_date_gte,
start_date_gt=start_date_gt,
start_date_lte=start_date_lte,
start_date_lt=start_date_lt,
end_date_gte=end_date_gte,
end_date_gt=end_date_gt,
end_date_lte=end_date_lte,
end_date_lt=end_date_lt,
duration_gte=duration_gte,
duration_gt=duration_gt,
duration_lte=duration_lte,
duration_lt=duration_lt,
updated_at_gte=updated_at_gte,
updated_at_gt=updated_at_gt,
updated_at_lte=updated_at_lte,
updated_at_lt=updated_at_lt,
conf_contains=conf_contains,
run_type=run_type,
state=state,
dag_version=dag_version,
bundle_version=bundle_version,
order_by=order_by,
run_id_pattern=run_id_pattern,
run_id_prefix_pattern=run_id_prefix_pattern,
triggering_user_name_pattern=triggering_user_name_pattern,
triggering_user_name_prefix_pattern=triggering_user_name_prefix_pattern,
dag_id_pattern=dag_id_pattern,
dag_id_prefix_pattern=dag_id_prefix_pattern,
partition_key_pattern=partition_key_pattern,
partition_key_prefix_pattern=partition_key_prefix_pattern,
consuming_asset_pattern=consuming_asset_pattern,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunCollectionResponse",
'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_runs_serialize(
self,
dag_id,
partition_date_gte,
partition_date_lte,
cursor,
limit,
offset,
run_after_gte,
run_after_gt,
run_after_lte,
run_after_lt,
logical_date_gte,
logical_date_gt,
logical_date_lte,
logical_date_lt,
start_date_gte,
start_date_gt,
start_date_lte,
start_date_lt,
end_date_gte,
end_date_gt,
end_date_lte,
end_date_lt,
duration_gte,
duration_gt,
duration_lte,
duration_lt,
updated_at_gte,
updated_at_gt,
updated_at_lte,
updated_at_lt,
conf_contains,
run_type,
state,
dag_version,
bundle_version,
order_by,
run_id_pattern,
run_id_prefix_pattern,
triggering_user_name_pattern,
triggering_user_name_prefix_pattern,
dag_id_pattern,
dag_id_prefix_pattern,
partition_key_pattern,
partition_key_prefix_pattern,
consuming_asset_pattern,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
'run_type': 'multi',
'state': 'multi',
'dag_version': 'multi',
'order_by': 'multi',
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
# process the query parameters
if partition_date_gte is not None:
if isinstance(partition_date_gte, date):
_query_params.append(
(
'partition_date_gte',
partition_date_gte.strftime(
self.api_client.configuration.date_format
)
)
)
else:
_query_params.append(('partition_date_gte', partition_date_gte))
if partition_date_lte is not None:
if isinstance(partition_date_lte, date):
_query_params.append(
(
'partition_date_lte',
partition_date_lte.strftime(
self.api_client.configuration.date_format
)
)
)
else:
_query_params.append(('partition_date_lte', partition_date_lte))
if cursor is not None:
_query_params.append(('cursor', cursor))
if limit is not None:
_query_params.append(('limit', limit))
if offset is not None:
_query_params.append(('offset', offset))
if run_after_gte is not None:
if isinstance(run_after_gte, datetime):
_query_params.append(
(
'run_after_gte',
run_after_gte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('run_after_gte', run_after_gte))
if run_after_gt is not None:
if isinstance(run_after_gt, datetime):
_query_params.append(
(
'run_after_gt',
run_after_gt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('run_after_gt', run_after_gt))
if run_after_lte is not None:
if isinstance(run_after_lte, datetime):
_query_params.append(
(
'run_after_lte',
run_after_lte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('run_after_lte', run_after_lte))
if run_after_lt is not None:
if isinstance(run_after_lt, datetime):
_query_params.append(
(
'run_after_lt',
run_after_lt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('run_after_lt', run_after_lt))
if logical_date_gte is not None:
if isinstance(logical_date_gte, datetime):
_query_params.append(
(
'logical_date_gte',
logical_date_gte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('logical_date_gte', logical_date_gte))
if logical_date_gt is not None:
if isinstance(logical_date_gt, datetime):
_query_params.append(
(
'logical_date_gt',
logical_date_gt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('logical_date_gt', logical_date_gt))
if logical_date_lte is not None:
if isinstance(logical_date_lte, datetime):
_query_params.append(
(
'logical_date_lte',
logical_date_lte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('logical_date_lte', logical_date_lte))
if logical_date_lt is not None:
if isinstance(logical_date_lt, datetime):
_query_params.append(
(
'logical_date_lt',
logical_date_lt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('logical_date_lt', logical_date_lt))
if start_date_gte is not None:
if isinstance(start_date_gte, datetime):
_query_params.append(
(
'start_date_gte',
start_date_gte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('start_date_gte', start_date_gte))
if start_date_gt is not None:
if isinstance(start_date_gt, datetime):
_query_params.append(
(
'start_date_gt',
start_date_gt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('start_date_gt', start_date_gt))
if start_date_lte is not None:
if isinstance(start_date_lte, datetime):
_query_params.append(
(
'start_date_lte',
start_date_lte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('start_date_lte', start_date_lte))
if start_date_lt is not None:
if isinstance(start_date_lt, datetime):
_query_params.append(
(
'start_date_lt',
start_date_lt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('start_date_lt', start_date_lt))
if end_date_gte is not None:
if isinstance(end_date_gte, datetime):
_query_params.append(
(
'end_date_gte',
end_date_gte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('end_date_gte', end_date_gte))
if end_date_gt is not None:
if isinstance(end_date_gt, datetime):
_query_params.append(
(
'end_date_gt',
end_date_gt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('end_date_gt', end_date_gt))
if end_date_lte is not None:
if isinstance(end_date_lte, datetime):
_query_params.append(
(
'end_date_lte',
end_date_lte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('end_date_lte', end_date_lte))
if end_date_lt is not None:
if isinstance(end_date_lt, datetime):
_query_params.append(
(
'end_date_lt',
end_date_lt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('end_date_lt', end_date_lt))
if duration_gte is not None:
_query_params.append(('duration_gte', duration_gte))
if duration_gt is not None:
_query_params.append(('duration_gt', duration_gt))
if duration_lte is not None:
_query_params.append(('duration_lte', duration_lte))
if duration_lt is not None:
_query_params.append(('duration_lt', duration_lt))
if updated_at_gte is not None:
if isinstance(updated_at_gte, datetime):
_query_params.append(
(
'updated_at_gte',
updated_at_gte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('updated_at_gte', updated_at_gte))
if updated_at_gt is not None:
if isinstance(updated_at_gt, datetime):
_query_params.append(
(
'updated_at_gt',
updated_at_gt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('updated_at_gt', updated_at_gt))
if updated_at_lte is not None:
if isinstance(updated_at_lte, datetime):
_query_params.append(
(
'updated_at_lte',
updated_at_lte.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('updated_at_lte', updated_at_lte))
if updated_at_lt is not None:
if isinstance(updated_at_lt, datetime):
_query_params.append(
(
'updated_at_lt',
updated_at_lt.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('updated_at_lt', updated_at_lt))
if conf_contains is not None:
_query_params.append(('conf_contains', conf_contains))
if run_type is not None:
_query_params.append(('run_type', run_type))
if state is not None:
_query_params.append(('state', state))
if dag_version is not None:
_query_params.append(('dag_version', dag_version))
if bundle_version is not None:
_query_params.append(('bundle_version', bundle_version))
if order_by is not None:
_query_params.append(('order_by', order_by))
if run_id_pattern is not None:
_query_params.append(('run_id_pattern', run_id_pattern))
if run_id_prefix_pattern is not None:
_query_params.append(('run_id_prefix_pattern', run_id_prefix_pattern))
if triggering_user_name_pattern is not None:
_query_params.append(('triggering_user_name_pattern', triggering_user_name_pattern))
if triggering_user_name_prefix_pattern is not None:
_query_params.append(('triggering_user_name_prefix_pattern', triggering_user_name_prefix_pattern))
if dag_id_pattern is not None:
_query_params.append(('dag_id_pattern', dag_id_pattern))
if dag_id_prefix_pattern is not None:
_query_params.append(('dag_id_prefix_pattern', dag_id_prefix_pattern))
if partition_key_pattern is not None:
_query_params.append(('partition_key_pattern', partition_key_pattern))
if partition_key_prefix_pattern is not None:
_query_params.append(('partition_key_prefix_pattern', partition_key_prefix_pattern))
if consuming_asset_pattern is not None:
_query_params.append(('consuming_asset_pattern', consuming_asset_pattern))
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not 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/dags/{dag_id}/dagRuns',
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_list_dag_runs_batch(
self,
dag_id: StrictStr,
dag_runs_batch_body: DAGRunsBatchBody,
_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,
) -> DAGRunCollectionResponse:
"""Get List Dag Runs Batch
Get a list of Dag Runs.
:param dag_id: (required)
:type dag_id: str
:param dag_runs_batch_body: (required)
:type dag_runs_batch_body: DAGRunsBatchBody
: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_list_dag_runs_batch_serialize(
dag_id=dag_id,
dag_runs_batch_body=dag_runs_batch_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunCollectionResponse",
'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_list_dag_runs_batch_with_http_info(
self,
dag_id: StrictStr,
dag_runs_batch_body: DAGRunsBatchBody,
_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[DAGRunCollectionResponse]:
"""Get List Dag Runs Batch
Get a list of Dag Runs.
:param dag_id: (required)
:type dag_id: str
:param dag_runs_batch_body: (required)
:type dag_runs_batch_body: DAGRunsBatchBody
: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_list_dag_runs_batch_serialize(
dag_id=dag_id,
dag_runs_batch_body=dag_runs_batch_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunCollectionResponse",
'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_list_dag_runs_batch_without_preload_content(
self,
dag_id: StrictStr,
dag_runs_batch_body: DAGRunsBatchBody,
_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 List Dag Runs Batch
Get a list of Dag Runs.
:param dag_id: (required)
:type dag_id: str
:param dag_runs_batch_body: (required)
:type dag_runs_batch_body: DAGRunsBatchBody
: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_list_dag_runs_batch_serialize(
dag_id=dag_id,
dag_runs_batch_body=dag_runs_batch_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunCollectionResponse",
'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_list_dag_runs_batch_serialize(
self,
dag_id,
dag_runs_batch_body,
_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, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if dag_runs_batch_body is not None:
_body_params = dag_runs_batch_body
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'OAuth2PasswordBearer',
'HTTPBearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/api/v2/dags/{dag_id}/dagRuns/list',
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_upstream_asset_events(
self,
dag_id: StrictStr,
dag_run_id: 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,
) -> AssetEventCollectionResponse:
"""Get Upstream Asset Events
If dag run is asset-triggered, return the asset events that triggered it.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: 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_upstream_asset_events_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "AssetEventCollectionResponse",
'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_upstream_asset_events_with_http_info(
self,
dag_id: StrictStr,
dag_run_id: 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[AssetEventCollectionResponse]:
"""Get Upstream Asset Events
If dag run is asset-triggered, return the asset events that triggered it.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: 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_upstream_asset_events_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "AssetEventCollectionResponse",
'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_upstream_asset_events_without_preload_content(
self,
dag_id: StrictStr,
dag_run_id: 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 Upstream Asset Events
If dag run is asset-triggered, return the asset events that triggered it.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: 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_upstream_asset_events_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "AssetEventCollectionResponse",
'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_upstream_asset_events_serialize(
self,
dag_id,
dag_run_id,
_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, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
if dag_run_id is not None:
_path_params['dag_run_id'] = dag_run_id
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not 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/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamAssetEvents',
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 patch_dag_run(
self,
dag_id: StrictStr,
dag_run_id: StrictStr,
dag_run_patch_body: DAGRunPatchBody,
update_mask: Optional[List[StrictStr]] = 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,
) -> DAGRunResponse:
"""Patch Dag Run
Modify a Dag Run.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: str
:param dag_run_patch_body: (required)
:type dag_run_patch_body: DAGRunPatchBody
:param update_mask:
:type update_mask: 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._patch_dag_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
dag_run_patch_body=dag_run_patch_body,
update_mask=update_mask,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunResponse",
'400': "HTTPExceptionResponse",
'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 patch_dag_run_with_http_info(
self,
dag_id: StrictStr,
dag_run_id: StrictStr,
dag_run_patch_body: DAGRunPatchBody,
update_mask: Optional[List[StrictStr]] = 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[DAGRunResponse]:
"""Patch Dag Run
Modify a Dag Run.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: str
:param dag_run_patch_body: (required)
:type dag_run_patch_body: DAGRunPatchBody
:param update_mask:
:type update_mask: 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._patch_dag_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
dag_run_patch_body=dag_run_patch_body,
update_mask=update_mask,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunResponse",
'400': "HTTPExceptionResponse",
'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 patch_dag_run_without_preload_content(
self,
dag_id: StrictStr,
dag_run_id: StrictStr,
dag_run_patch_body: DAGRunPatchBody,
update_mask: Optional[List[StrictStr]] = 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:
"""Patch Dag Run
Modify a Dag Run.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: str
:param dag_run_patch_body: (required)
:type dag_run_patch_body: DAGRunPatchBody
:param update_mask:
:type update_mask: 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._patch_dag_run_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
dag_run_patch_body=dag_run_patch_body,
update_mask=update_mask,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunResponse",
'400': "HTTPExceptionResponse",
'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 _patch_dag_run_serialize(
self,
dag_id,
dag_run_id,
dag_run_patch_body,
update_mask,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
'update_mask': 'multi',
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
if dag_run_id is not None:
_path_params['dag_run_id'] = dag_run_id
# process the query parameters
if update_mask is not None:
_query_params.append(('update_mask', update_mask))
# process the header parameters
# process the form parameters
# process the body parameter
if dag_run_patch_body is not None:
_body_params = dag_run_patch_body
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'OAuth2PasswordBearer',
'HTTPBearer'
]
return self.api_client.param_serialize(
method='PATCH',
resource_path='/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}',
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 trigger_dag_run(
self,
dag_id: Any,
trigger_dag_run_post_body: TriggerDAGRunPostBody,
_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,
) -> DAGRunResponse:
"""Trigger Dag Run
Trigger a Dag.
:param dag_id: (required)
:type dag_id: object
:param trigger_dag_run_post_body: (required)
:type trigger_dag_run_post_body: TriggerDAGRunPostBody
: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._trigger_dag_run_serialize(
dag_id=dag_id,
trigger_dag_run_post_body=trigger_dag_run_post_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunResponse",
'400': "HTTPExceptionResponse",
'401': "HTTPExceptionResponse",
'403': "HTTPExceptionResponse",
'404': "HTTPExceptionResponse",
'409': "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 trigger_dag_run_with_http_info(
self,
dag_id: Any,
trigger_dag_run_post_body: TriggerDAGRunPostBody,
_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[DAGRunResponse]:
"""Trigger Dag Run
Trigger a Dag.
:param dag_id: (required)
:type dag_id: object
:param trigger_dag_run_post_body: (required)
:type trigger_dag_run_post_body: TriggerDAGRunPostBody
: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._trigger_dag_run_serialize(
dag_id=dag_id,
trigger_dag_run_post_body=trigger_dag_run_post_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunResponse",
'400': "HTTPExceptionResponse",
'401': "HTTPExceptionResponse",
'403': "HTTPExceptionResponse",
'404': "HTTPExceptionResponse",
'409': "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 trigger_dag_run_without_preload_content(
self,
dag_id: Any,
trigger_dag_run_post_body: TriggerDAGRunPostBody,
_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:
"""Trigger Dag Run
Trigger a Dag.
:param dag_id: (required)
:type dag_id: object
:param trigger_dag_run_post_body: (required)
:type trigger_dag_run_post_body: TriggerDAGRunPostBody
: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._trigger_dag_run_serialize(
dag_id=dag_id,
trigger_dag_run_post_body=trigger_dag_run_post_body,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "DAGRunResponse",
'400': "HTTPExceptionResponse",
'401': "HTTPExceptionResponse",
'403': "HTTPExceptionResponse",
'404': "HTTPExceptionResponse",
'409': "HTTPExceptionResponse",
'422': "HTTPValidationError",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _trigger_dag_run_serialize(
self,
dag_id,
trigger_dag_run_post_body,
_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, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if trigger_dag_run_post_body is not None:
_body_params = trigger_dag_run_post_body
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'OAuth2PasswordBearer',
'HTTPBearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/api/v2/dags/{dag_id}/dagRuns',
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 wait_dag_run_until_finished(
self,
dag_id: StrictStr,
dag_run_id: StrictStr,
interval: Annotated[Union[Annotated[float, Field(strict=True, gt=0.0)], Annotated[int, Field(strict=True, gt=0)]], Field(description="Seconds to wait between dag run state checks")],
result: Annotated[Optional[List[StrictStr]], Field(description="Collect result XCom from task. Can be set multiple times. If unset, return value of the return task as specified in the dag (in present) is returned by default.")] = 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,
) -> object:
"""Experimental: Wait for a dag run to complete, and return task results if requested.
🚧 This is an experimental endpoint and may change or be removed without notice.Successful response are streamed as newline-delimited JSON (NDJSON). Each line is a JSON object representing the Dag run state.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: str
:param interval: Seconds to wait between dag run state checks (required)
:type interval: float
:param result: Collect result XCom from task. Can be set multiple times. If unset, return value of the return task as specified in the dag (in present) is returned by default.
:type result: 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._wait_dag_run_until_finished_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
interval=interval,
result=result,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "object",
'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 wait_dag_run_until_finished_with_http_info(
self,
dag_id: StrictStr,
dag_run_id: StrictStr,
interval: Annotated[Union[Annotated[float, Field(strict=True, gt=0.0)], Annotated[int, Field(strict=True, gt=0)]], Field(description="Seconds to wait between dag run state checks")],
result: Annotated[Optional[List[StrictStr]], Field(description="Collect result XCom from task. Can be set multiple times. If unset, return value of the return task as specified in the dag (in present) is returned by default.")] = 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[object]:
"""Experimental: Wait for a dag run to complete, and return task results if requested.
🚧 This is an experimental endpoint and may change or be removed without notice.Successful response are streamed as newline-delimited JSON (NDJSON). Each line is a JSON object representing the Dag run state.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: str
:param interval: Seconds to wait between dag run state checks (required)
:type interval: float
:param result: Collect result XCom from task. Can be set multiple times. If unset, return value of the return task as specified in the dag (in present) is returned by default.
:type result: 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._wait_dag_run_until_finished_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
interval=interval,
result=result,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "object",
'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 wait_dag_run_until_finished_without_preload_content(
self,
dag_id: StrictStr,
dag_run_id: StrictStr,
interval: Annotated[Union[Annotated[float, Field(strict=True, gt=0.0)], Annotated[int, Field(strict=True, gt=0)]], Field(description="Seconds to wait between dag run state checks")],
result: Annotated[Optional[List[StrictStr]], Field(description="Collect result XCom from task. Can be set multiple times. If unset, return value of the return task as specified in the dag (in present) is returned by default.")] = 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:
"""Experimental: Wait for a dag run to complete, and return task results if requested.
🚧 This is an experimental endpoint and may change or be removed without notice.Successful response are streamed as newline-delimited JSON (NDJSON). Each line is a JSON object representing the Dag run state.
:param dag_id: (required)
:type dag_id: str
:param dag_run_id: (required)
:type dag_run_id: str
:param interval: Seconds to wait between dag run state checks (required)
:type interval: float
:param result: Collect result XCom from task. Can be set multiple times. If unset, return value of the return task as specified in the dag (in present) is returned by default.
:type result: 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._wait_dag_run_until_finished_serialize(
dag_id=dag_id,
dag_run_id=dag_run_id,
interval=interval,
result=result,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "object",
'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 _wait_dag_run_until_finished_serialize(
self,
dag_id,
dag_run_id,
interval,
result,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
'result': 'multi',
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_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 dag_id is not None:
_path_params['dag_id'] = dag_id
if dag_run_id is not None:
_path_params['dag_run_id'] = dag_run_id
# process the query parameters
if interval is not None:
_query_params.append(('interval', interval))
if result is not None:
_query_params.append(('result', result))
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json',
'application/x-ndjson'
]
)
# authentication setting
_auth_settings: List[str] = [
'OAuth2PasswordBearer',
'HTTPBearer'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/wait',
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
)