| """ | |
| Airflow API | |
| Airflow API. All endpoints located under ``/api/v2`` can be used safely, are stable and backward compatible. Endpoints located under ``/ui`` are dedicated to the UI and are subject to breaking change depending on the need of the frontend. Users should not rely on those but use the public ones instead. **Filtering with pattern parameters.** Many list endpoints accept ``*_pattern`` and ``*_prefix_pattern`` query parameters. Unless a parameter's own description says otherwise, ``*_pattern`` is a case-insensitive substring match (SQL ``ILIKE '%term%'``) where ``%`` matches any sequence and ``_`` matches any single character (e.g. ``%customer_%``) — convenient, but it cannot use B-tree indexes, so it is slow on large tables. ``*_prefix_pattern`` matches the start of the value, is case-sensitive and index-friendly (prefer it at scale); there ``%`` and ``_`` are literal and trailing non-alphanumeric characters are stripped so the range scan stays index-compatible under locale-aware collations (e.g. ``test_`` matches values starting with ``test``, and ``s3://`` matches ``s3``). In both, ``|`` means OR (e.g. ``dag1|dag2``) and ``~`` matches everything. Regular expressions are not supported by these parameters; regex-capable endpoints expose a separate parameter. | |
| The version of the OpenAPI document: 2 | |
| Generated by OpenAPI Generator (https://openapi-generator.tech) | |
| Do not edit the class manually. | |
| """ # noqa: E501 | |
| import warnings | |
| from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt | |
| from typing import Any, Dict, List, Optional, Tuple, Union | |
| from typing_extensions import Annotated | |
| from pydantic import Field, StrictStr | |
| from typing import List, Optional | |
| from typing_extensions import Annotated | |
| from airflow_client.client.models.bulk_body_variable_body import BulkBodyVariableBody | |
| from airflow_client.client.models.bulk_response import BulkResponse | |
| from airflow_client.client.models.variable_body import VariableBody | |
| from airflow_client.client.models.variable_collection_response import VariableCollectionResponse | |
| from airflow_client.client.models.variable_response import VariableResponse | |
| 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 VariableApi: | |
| """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_variables( | |
| self, | |
| bulk_body_variable_body: BulkBodyVariableBody, | |
| _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 Variables | |
| Bulk create, update, and delete variables. | |
| :param bulk_body_variable_body: (required) | |
| :type bulk_body_variable_body: BulkBodyVariableBody | |
| :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_variables_serialize( | |
| bulk_body_variable_body=bulk_body_variable_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_variables_with_http_info( | |
| self, | |
| bulk_body_variable_body: BulkBodyVariableBody, | |
| _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 Variables | |
| Bulk create, update, and delete variables. | |
| :param bulk_body_variable_body: (required) | |
| :type bulk_body_variable_body: BulkBodyVariableBody | |
| :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_variables_serialize( | |
| bulk_body_variable_body=bulk_body_variable_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_variables_without_preload_content( | |
| self, | |
| bulk_body_variable_body: BulkBodyVariableBody, | |
| _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 Variables | |
| Bulk create, update, and delete variables. | |
| :param bulk_body_variable_body: (required) | |
| :type bulk_body_variable_body: BulkBodyVariableBody | |
| :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_variables_serialize( | |
| bulk_body_variable_body=bulk_body_variable_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_variables_serialize( | |
| self, | |
| bulk_body_variable_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 bulk_body_variable_body is not None: | |
| _body_params = bulk_body_variable_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/variables', | |
| 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_variable( | |
| self, | |
| variable_key: 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 Variable | |
| Delete a variable entry. | |
| :param variable_key: (required) | |
| :type variable_key: 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_variable_serialize( | |
| variable_key=variable_key, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '204': None, | |
| '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_variable_with_http_info( | |
| self, | |
| variable_key: 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 Variable | |
| Delete a variable entry. | |
| :param variable_key: (required) | |
| :type variable_key: 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_variable_serialize( | |
| variable_key=variable_key, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '204': None, | |
| '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_variable_without_preload_content( | |
| self, | |
| variable_key: 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 Variable | |
| Delete a variable entry. | |
| :param variable_key: (required) | |
| :type variable_key: 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_variable_serialize( | |
| variable_key=variable_key, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '204': None, | |
| '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_variable_serialize( | |
| self, | |
| variable_key, | |
| _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 variable_key is not None: | |
| _path_params['variable_key'] = variable_key | |
| # 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/variables/{variable_key}', | |
| 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_variable( | |
| self, | |
| variable_key: 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, | |
| ) -> VariableResponse: | |
| """Get Variable | |
| Get a variable entry. | |
| :param variable_key: (required) | |
| :type variable_key: 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_variable_serialize( | |
| variable_key=variable_key, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "VariableResponse", | |
| '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_variable_with_http_info( | |
| self, | |
| variable_key: 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[VariableResponse]: | |
| """Get Variable | |
| Get a variable entry. | |
| :param variable_key: (required) | |
| :type variable_key: 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_variable_serialize( | |
| variable_key=variable_key, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "VariableResponse", | |
| '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_variable_without_preload_content( | |
| self, | |
| variable_key: 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 Variable | |
| Get a variable entry. | |
| :param variable_key: (required) | |
| :type variable_key: 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_variable_serialize( | |
| variable_key=variable_key, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "VariableResponse", | |
| '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_variable_serialize( | |
| self, | |
| variable_key, | |
| _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 variable_key is not None: | |
| _path_params['variable_key'] = variable_key | |
| # 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/variables/{variable_key}', | |
| 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_variables( | |
| self, | |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| order_by: Annotated[Optional[List[StrictStr]], Field(description="Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted, team_name`")] = None, | |
| variable_key_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `variable_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None, | |
| variable_key_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = 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, | |
| ) -> VariableCollectionResponse: | |
| """Get Variables | |
| Get all Variables entries. | |
| :param limit: | |
| :type limit: int | |
| :param offset: | |
| :type offset: int | |
| :param order_by: Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted, team_name` | |
| :type order_by: List[str] | |
| :param variable_key_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `variable_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". | |
| :type variable_key_pattern: str | |
| :param variable_key_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". | |
| :type variable_key_prefix_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_variables_serialize( | |
| limit=limit, | |
| offset=offset, | |
| order_by=order_by, | |
| variable_key_pattern=variable_key_pattern, | |
| variable_key_prefix_pattern=variable_key_prefix_pattern, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "VariableCollectionResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| response_data.read() | |
| return self.api_client.response_deserialize( | |
| response_data=response_data, | |
| response_types_map=_response_types_map, | |
| ).data | |
| @validate_call | |
| def get_variables_with_http_info( | |
| self, | |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| order_by: Annotated[Optional[List[StrictStr]], Field(description="Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted, team_name`")] = None, | |
| variable_key_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `variable_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None, | |
| variable_key_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = 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[VariableCollectionResponse]: | |
| """Get Variables | |
| Get all Variables entries. | |
| :param limit: | |
| :type limit: int | |
| :param offset: | |
| :type offset: int | |
| :param order_by: Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted, team_name` | |
| :type order_by: List[str] | |
| :param variable_key_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `variable_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". | |
| :type variable_key_pattern: str | |
| :param variable_key_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". | |
| :type variable_key_prefix_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_variables_serialize( | |
| limit=limit, | |
| offset=offset, | |
| order_by=order_by, | |
| variable_key_pattern=variable_key_pattern, | |
| variable_key_prefix_pattern=variable_key_prefix_pattern, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "VariableCollectionResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| response_data.read() | |
| return self.api_client.response_deserialize( | |
| response_data=response_data, | |
| response_types_map=_response_types_map, | |
| ) | |
| @validate_call | |
| def get_variables_without_preload_content( | |
| self, | |
| limit: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, | |
| order_by: Annotated[Optional[List[StrictStr]], Field(description="Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted, team_name`")] = None, | |
| variable_key_pattern: Annotated[Optional[StrictStr], Field(description="Case-insensitive substring match (SQL `ILIKE`). Slower than `variable_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\".")] = None, | |
| variable_key_prefix_pattern: Annotated[Optional[StrictStr], Field(description="Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\".")] = 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 Variables | |
| Get all Variables entries. | |
| :param limit: | |
| :type limit: int | |
| :param offset: | |
| :type offset: int | |
| :param order_by: Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted, team_name` | |
| :type order_by: List[str] | |
| :param variable_key_pattern: Case-insensitive substring match (SQL `ILIKE`). Slower than `variable_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". | |
| :type variable_key_pattern: str | |
| :param variable_key_prefix_pattern: Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". | |
| :type variable_key_prefix_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_variables_serialize( | |
| limit=limit, | |
| offset=offset, | |
| order_by=order_by, | |
| variable_key_pattern=variable_key_pattern, | |
| variable_key_prefix_pattern=variable_key_prefix_pattern, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '200': "VariableCollectionResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| return response_data.response | |
| def _get_variables_serialize( | |
| self, | |
| limit, | |
| offset, | |
| order_by, | |
| variable_key_pattern, | |
| variable_key_prefix_pattern, | |
| _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 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)) | |
| if variable_key_pattern is not None: | |
| _query_params.append(('variable_key_pattern', variable_key_pattern)) | |
| if variable_key_prefix_pattern is not None: | |
| _query_params.append(('variable_key_prefix_pattern', variable_key_prefix_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/variables', | |
| 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_variable( | |
| self, | |
| variable_key: StrictStr, | |
| variable_body: VariableBody, | |
| 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, | |
| ) -> VariableResponse: | |
| """Patch Variable | |
| Update a variable by key. | |
| :param variable_key: (required) | |
| :type variable_key: str | |
| :param variable_body: (required) | |
| :type variable_body: VariableBody | |
| :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_variable_serialize( | |
| variable_key=variable_key, | |
| variable_body=variable_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': "VariableResponse", | |
| '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_variable_with_http_info( | |
| self, | |
| variable_key: StrictStr, | |
| variable_body: VariableBody, | |
| 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[VariableResponse]: | |
| """Patch Variable | |
| Update a variable by key. | |
| :param variable_key: (required) | |
| :type variable_key: str | |
| :param variable_body: (required) | |
| :type variable_body: VariableBody | |
| :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_variable_serialize( | |
| variable_key=variable_key, | |
| variable_body=variable_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': "VariableResponse", | |
| '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_variable_without_preload_content( | |
| self, | |
| variable_key: StrictStr, | |
| variable_body: VariableBody, | |
| 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 Variable | |
| Update a variable by key. | |
| :param variable_key: (required) | |
| :type variable_key: str | |
| :param variable_body: (required) | |
| :type variable_body: VariableBody | |
| :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_variable_serialize( | |
| variable_key=variable_key, | |
| variable_body=variable_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': "VariableResponse", | |
| '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_variable_serialize( | |
| self, | |
| variable_key, | |
| variable_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 variable_key is not None: | |
| _path_params['variable_key'] = variable_key | |
| # 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 variable_body is not None: | |
| _body_params = variable_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/variables/{variable_key}', | |
| 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 post_variable( | |
| self, | |
| variable_body: VariableBody, | |
| _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, | |
| ) -> VariableResponse: | |
| """Post Variable | |
| Create a variable. | |
| :param variable_body: (required) | |
| :type variable_body: VariableBody | |
| :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._post_variable_serialize( | |
| variable_body=variable_body, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '201': "VariableResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "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 post_variable_with_http_info( | |
| self, | |
| variable_body: VariableBody, | |
| _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[VariableResponse]: | |
| """Post Variable | |
| Create a variable. | |
| :param variable_body: (required) | |
| :type variable_body: VariableBody | |
| :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._post_variable_serialize( | |
| variable_body=variable_body, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '201': "VariableResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "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 post_variable_without_preload_content( | |
| self, | |
| variable_body: VariableBody, | |
| _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: | |
| """Post Variable | |
| Create a variable. | |
| :param variable_body: (required) | |
| :type variable_body: VariableBody | |
| :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._post_variable_serialize( | |
| variable_body=variable_body, | |
| _request_auth=_request_auth, | |
| _content_type=_content_type, | |
| _headers=_headers, | |
| _host_index=_host_index | |
| ) | |
| _response_types_map: Dict[str, Optional[str]] = { | |
| '201': "VariableResponse", | |
| '401': "HTTPExceptionResponse", | |
| '403': "HTTPExceptionResponse", | |
| '409': "HTTPExceptionResponse", | |
| '422': "HTTPValidationError", | |
| } | |
| response_data = self.api_client.call_api( | |
| *_param, | |
| _request_timeout=_request_timeout | |
| ) | |
| return response_data.response | |
| def _post_variable_serialize( | |
| self, | |
| variable_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 variable_body is not None: | |
| _body_params = variable_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/variables', | |
| 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 | |
| ) | |