blob: 3d349e8444ecbaca0483a2d3cfb6bded5febcdc6 [file]
# 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. **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
from __future__ import annotations
import pprint
import re # noqa: F401
import json
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from airflow_client.client.models.dag_version_diff_change_response import DagVersionDiffChangeResponse
from airflow_client.client.models.dag_version_diff_mode import DagVersionDiffMode
from airflow_client.client.models.dag_version_diff_serializer_versions import DagVersionDiffSerializerVersions
from airflow_client.client.models.dag_version_diff_values_status import DagVersionDiffValuesStatus
from typing import Optional, Set
from typing_extensions import Self
from pydantic_core import to_jsonable_python
class DagVersionDiffResponse(BaseModel):
"""
Observed-state difference between two stored Dag versions.
""" # noqa: E501
base_version_number: StrictInt
changes: List[DagVersionDiffChangeResponse]
diff_schema_version: StrictInt = Field(description="Wire format of this payload. Incremented when its shape changes.")
mode: DagVersionDiffMode
serializer_versions: DagVersionDiffSerializerVersions
target_version_number: StrictInt
total_changes: StrictInt = Field(description="Underlying changes across every disclosed path, not the number of records. Exact when `truncated` is false; a lower bound when it is true, because the changes at dropped paths are not counted.")
truncated: StrictBool = Field(description="Whether a change at a path not already in `changes` was dropped to stay within `max_changes`. Paths that are absent are absent, not unchanged.")
unavailable_reason: Optional[StrictStr] = None
values_status: DagVersionDiffValuesStatus
__properties: ClassVar[List[str]] = ["base_version_number", "changes", "diff_schema_version", "mode", "serializer_versions", "target_version_number", "total_changes", "truncated", "unavailable_reason", "values_status"]
model_config = ConfigDict(
validate_by_name=True,
validate_by_alias=True,
validate_assignment=True,
protected_namespaces=(),
)
def to_str(self) -> str:
"""Returns the string representation of the model using alias"""
return pprint.pformat(self.model_dump(by_alias=True))
def to_json(self) -> str:
"""Returns the JSON representation of the model using alias"""
return json.dumps(to_jsonable_python(self.to_dict()))
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
"""Create an instance of DagVersionDiffResponse from a JSON string"""
return cls.from_dict(json.loads(json_str))
def to_dict(self) -> Dict[str, Any]:
"""Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic's
`self.model_dump(by_alias=True)`:
* `None` is only added to the output dict for nullable fields that
were set at model initialization. Other fields with value `None`
are ignored.
"""
excluded_fields: Set[str] = set([
])
_dict = self.model_dump(
by_alias=True,
exclude=excluded_fields,
exclude_none=True,
)
# override the default output from pydantic by calling `to_dict()` of each item in changes (list)
_items = []
if self.changes:
for _item_changes in self.changes:
_items.append(_item_changes.to_dict() if _item_changes is not None else None)
_dict['changes'] = _items
# override the default output from pydantic by calling `to_dict()` of serializer_versions
if self.serializer_versions:
_dict['serializer_versions'] = self.serializer_versions.to_dict()
return _dict
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"""Create an instance of DagVersionDiffResponse from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate({
"base_version_number": obj.get("base_version_number"),
"changes": [DagVersionDiffChangeResponse.from_dict(_item) for _item in obj["changes"]] if obj.get("changes") is not None else None,
"diff_schema_version": obj.get("diff_schema_version"),
"mode": obj.get("mode"),
"serializer_versions": DagVersionDiffSerializerVersions.from_dict(obj["serializer_versions"]) if obj.get("serializer_versions") is not None else None,
"target_version_number": obj.get("target_version_number"),
"total_changes": obj.get("total_changes"),
"truncated": obj.get("truncated"),
"unavailable_reason": obj.get("unavailable_reason"),
"values_status": obj.get("values_status")
})
return _obj