| # coding: utf-8 |
| |
| """ |
| 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. |
| |
| The version of the OpenAPI document: 2 |
| Generated by OpenAPI Generator (https://openapi-generator.tech) |
| |
| Do not edit the class manually. |
| """ # noqa: E501 |
| |
| import warnings |
| from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt |
| from typing import Any, Dict, List, Optional, Tuple, Union |
| from typing_extensions import Annotated |
| |
| from pydantic import Field, StrictStr |
| from typing import List, Optional |
| from typing_extensions import Annotated |
| from airflow_client.client.models.backfill_collection_response import BackfillCollectionResponse |
| from airflow_client.client.models.backfill_post_body import BackfillPostBody |
| from airflow_client.client.models.backfill_response import BackfillResponse |
| from airflow_client.client.models.dry_run_backfill_collection_response import DryRunBackfillCollectionResponse |
| |
| 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 BackfillApi: |
| """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 cancel_backfill( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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, |
| ) -> BackfillResponse: |
| """Cancel Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._cancel_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 cancel_backfill_with_http_info( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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[BackfillResponse]: |
| """Cancel Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._cancel_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 cancel_backfill_without_preload_content( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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: |
| """Cancel Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._cancel_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 _cancel_backfill_serialize( |
| self, |
| backfill_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 backfill_id is not None: |
| _path_params['backfill_id'] = backfill_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='PUT', |
| resource_path='/api/v2/backfills/{backfill_id}/cancel', |
| 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 create_backfill( |
| self, |
| backfill_post_body: BackfillPostBody, |
| _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, |
| ) -> BackfillResponse: |
| """Create Backfill |
| |
| |
| :param backfill_post_body: (required) |
| :type backfill_post_body: BackfillPostBody |
| :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._create_backfill_serialize( |
| backfill_post_body=backfill_post_body, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 create_backfill_with_http_info( |
| self, |
| backfill_post_body: BackfillPostBody, |
| _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[BackfillResponse]: |
| """Create Backfill |
| |
| |
| :param backfill_post_body: (required) |
| :type backfill_post_body: BackfillPostBody |
| :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._create_backfill_serialize( |
| backfill_post_body=backfill_post_body, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 create_backfill_without_preload_content( |
| self, |
| backfill_post_body: BackfillPostBody, |
| _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: |
| """Create Backfill |
| |
| |
| :param backfill_post_body: (required) |
| :type backfill_post_body: BackfillPostBody |
| :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._create_backfill_serialize( |
| backfill_post_body=backfill_post_body, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 _create_backfill_serialize( |
| self, |
| backfill_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 |
| # process the query parameters |
| # process the header parameters |
| # process the form parameters |
| # process the body parameter |
| if backfill_post_body is not None: |
| _body_params = backfill_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/backfills', |
| 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 create_backfill_dry_run( |
| self, |
| backfill_post_body: BackfillPostBody, |
| _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, |
| ) -> DryRunBackfillCollectionResponse: |
| """Create Backfill Dry Run |
| |
| |
| :param backfill_post_body: (required) |
| :type backfill_post_body: BackfillPostBody |
| :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._create_backfill_dry_run_serialize( |
| backfill_post_body=backfill_post_body, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "DryRunBackfillCollectionResponse", |
| '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 create_backfill_dry_run_with_http_info( |
| self, |
| backfill_post_body: BackfillPostBody, |
| _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[DryRunBackfillCollectionResponse]: |
| """Create Backfill Dry Run |
| |
| |
| :param backfill_post_body: (required) |
| :type backfill_post_body: BackfillPostBody |
| :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._create_backfill_dry_run_serialize( |
| backfill_post_body=backfill_post_body, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "DryRunBackfillCollectionResponse", |
| '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 create_backfill_dry_run_without_preload_content( |
| self, |
| backfill_post_body: BackfillPostBody, |
| _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: |
| """Create Backfill Dry Run |
| |
| |
| :param backfill_post_body: (required) |
| :type backfill_post_body: BackfillPostBody |
| :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._create_backfill_dry_run_serialize( |
| backfill_post_body=backfill_post_body, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "DryRunBackfillCollectionResponse", |
| '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 _create_backfill_dry_run_serialize( |
| self, |
| backfill_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 |
| # process the query parameters |
| # process the header parameters |
| # process the form parameters |
| # process the body parameter |
| if backfill_post_body is not None: |
| _body_params = backfill_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/backfills/dry_run', |
| 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_backfill( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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, |
| ) -> BackfillResponse: |
| """Get Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._get_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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_backfill_with_http_info( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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[BackfillResponse]: |
| """Get Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._get_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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_backfill_without_preload_content( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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 Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._get_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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_backfill_serialize( |
| self, |
| backfill_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 backfill_id is not None: |
| _path_params['backfill_id'] = backfill_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/backfills/{backfill_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 list_backfills( |
| self, |
| dag_id: StrictStr, |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, |
| order_by: 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, |
| ) -> BackfillCollectionResponse: |
| """List Backfills |
| |
| |
| :param dag_id: (required) |
| :type dag_id: str |
| :param limit: |
| :type limit: int |
| :param offset: |
| :type offset: int |
| :param order_by: |
| :type order_by: List[str] |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._list_backfills_serialize( |
| dag_id=dag_id, |
| limit=limit, |
| offset=offset, |
| order_by=order_by, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillCollectionResponse", |
| '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 list_backfills_with_http_info( |
| self, |
| dag_id: StrictStr, |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, |
| order_by: 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[BackfillCollectionResponse]: |
| """List Backfills |
| |
| |
| :param dag_id: (required) |
| :type dag_id: str |
| :param limit: |
| :type limit: int |
| :param offset: |
| :type offset: int |
| :param order_by: |
| :type order_by: List[str] |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._list_backfills_serialize( |
| dag_id=dag_id, |
| limit=limit, |
| offset=offset, |
| order_by=order_by, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillCollectionResponse", |
| '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 list_backfills_without_preload_content( |
| self, |
| dag_id: StrictStr, |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, |
| order_by: 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: |
| """List Backfills |
| |
| |
| :param dag_id: (required) |
| :type dag_id: str |
| :param limit: |
| :type limit: int |
| :param offset: |
| :type offset: int |
| :param order_by: |
| :type order_by: List[str] |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._list_backfills_serialize( |
| dag_id=dag_id, |
| limit=limit, |
| offset=offset, |
| order_by=order_by, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillCollectionResponse", |
| '401': "HTTPExceptionResponse", |
| '403': "HTTPExceptionResponse", |
| '422': "HTTPValidationError", |
| } |
| response_data = self.api_client.call_api( |
| *_param, |
| _request_timeout=_request_timeout |
| ) |
| return response_data.response |
| |
| |
| def _list_backfills_serialize( |
| self, |
| dag_id, |
| limit, |
| offset, |
| order_by, |
| _request_auth, |
| _content_type, |
| _headers, |
| _host_index, |
| ) -> RequestSerialized: |
| |
| _host = None |
| |
| _collection_formats: Dict[str, str] = { |
| 'order_by': 'multi', |
| } |
| |
| _path_params: Dict[str, str] = {} |
| _query_params: List[Tuple[str, str]] = [] |
| _header_params: Dict[str, 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 |
| # process the query parameters |
| if dag_id is not None: |
| |
| _query_params.append(('dag_id', dag_id)) |
| |
| if limit is not None: |
| |
| _query_params.append(('limit', limit)) |
| |
| if offset is not None: |
| |
| _query_params.append(('offset', offset)) |
| |
| if order_by is not None: |
| |
| _query_params.append(('order_by', order_by)) |
| |
| # process the header parameters |
| # process the form parameters |
| # process the body parameter |
| |
| |
| # set the HTTP header `Accept` |
| if '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/backfills', |
| 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 pause_backfill( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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, |
| ) -> BackfillResponse: |
| """Pause Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._pause_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 pause_backfill_with_http_info( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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[BackfillResponse]: |
| """Pause Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._pause_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 pause_backfill_without_preload_content( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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: |
| """Pause Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._pause_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 _pause_backfill_serialize( |
| self, |
| backfill_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 backfill_id is not None: |
| _path_params['backfill_id'] = backfill_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='PUT', |
| resource_path='/api/v2/backfills/{backfill_id}/pause', |
| 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 unpause_backfill( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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, |
| ) -> BackfillResponse: |
| """Unpause Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._unpause_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 unpause_backfill_with_http_info( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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[BackfillResponse]: |
| """Unpause Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._unpause_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 unpause_backfill_without_preload_content( |
| self, |
| backfill_id: Annotated[int, Field(strict=True, ge=0)], |
| _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: |
| """Unpause Backfill |
| |
| |
| :param backfill_id: (required) |
| :type backfill_id: int |
| :param _request_timeout: timeout setting for this request. If one |
| number provided, it will be total request |
| timeout. It can also be a pair (tuple) of |
| (connection, read) timeouts. |
| :type _request_timeout: int, tuple(int, int), optional |
| :param _request_auth: set to override the auth_settings for an a single |
| request; this effectively ignores the |
| authentication in the spec for a single request. |
| :type _request_auth: dict, optional |
| :param _content_type: force content-type for the request. |
| :type _content_type: str, Optional |
| :param _headers: set to override the headers for a single |
| request; this effectively ignores the headers |
| in the spec for a single request. |
| :type _headers: dict, optional |
| :param _host_index: set to override the host_index for a single |
| request; this effectively ignores the host_index |
| in the spec for a single request. |
| :type _host_index: int, optional |
| :return: Returns the result object. |
| """ # noqa: E501 |
| |
| _param = self._unpause_backfill_serialize( |
| backfill_id=backfill_id, |
| _request_auth=_request_auth, |
| _content_type=_content_type, |
| _headers=_headers, |
| _host_index=_host_index |
| ) |
| |
| _response_types_map: Dict[str, Optional[str]] = { |
| '200': "BackfillResponse", |
| '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 _unpause_backfill_serialize( |
| self, |
| backfill_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 backfill_id is not None: |
| _path_params['backfill_id'] = backfill_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='PUT', |
| resource_path='/api/v2/backfills/{backfill_id}/unpause', |
| 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 |
| ) |
| |
| |
