cosmotech-api 3.1.0.dev0__py3-none-any.whl → 3.2.0__py3-none-any.whl

cosmotech_api/models/runner_changed_parameter_value.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.2.0
+    Contact: platform@cosmotech.com
+    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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunnerChangedParameterValue(BaseModel):
+    """
+    the difference between the values of a parameter
+    """ # noqa: E501
+    parameter_id: Optional[StrictStr] = Field(default=None, description="the parameter id the values refer to", alias="parameterId")
+    var_type: Optional[StrictStr] = Field(default=None, description="the parameter value type", alias="varType")
+    value: Optional[StrictStr] = Field(default=None, description="the parameter value for the reference Runner")
+    compared_value: Optional[StrictStr] = Field(default=None, description="the parameter value for the compared Runner", alias="comparedValue")
+    __properties: ClassVar[List[str]] = ["parameterId", "varType", "value", "comparedValue"]
+
+    model_config = {
+        "populate_by_name": 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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RunnerChangedParameterValue 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "parameter_id",
+            "var_type",
+            "value",
+            "compared_value",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunnerChangedParameterValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameterId": obj.get("parameterId"),
+            "varType": obj.get("varType"),
+            "value": obj.get("value"),
+            "comparedValue": obj.get("comparedValue")
+        })
+        return _obj
+
+

cosmotech_api/models/runner_comparison_result.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.2.0
+    Contact: platform@cosmotech.com
+    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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.runner_changed_parameter_value import RunnerChangedParameterValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunnerComparisonResult(BaseModel):
+    """
+    the result of the comparison of two runners
+    """ # noqa: E501
+    runner_id: Optional[StrictStr] = Field(default=None, description="the Runner Id which is the reference for the comparison", alias="runnerId")
+    compared_runner_id: Optional[StrictStr] = Field(default=None, description="the Runner Id the reference Runner is compared to", alias="comparedRunnerId")
+    changed_values: Optional[List[RunnerChangedParameterValue]] = Field(default=None, description="the list of changed values for parameters", alias="changedValues")
+    __properties: ClassVar[List[str]] = ["runnerId", "comparedRunnerId", "changedValues"]
+
+    model_config = {
+        "populate_by_name": 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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RunnerComparisonResult 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "runner_id",
+            "compared_runner_id",
+            "changed_values",
+        ])
+
+        _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 changed_values (list)
+        _items = []
+        if self.changed_values:
+            for _item in self.changed_values:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['changedValues'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunnerComparisonResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "runnerId": obj.get("runnerId"),
+            "comparedRunnerId": obj.get("comparedRunnerId"),
+            "changedValues": [RunnerChangedParameterValue.from_dict(_item) for _item in obj["changedValues"]] if obj.get("changedValues") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/runner_data_download_info.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.2.0
+    Contact: platform@cosmotech.com
+    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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.runner_job_state import RunnerJobState
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunnerDataDownloadInfo(BaseModel):
+    """
+    Runner data download job info
+    """ # noqa: E501
+    url: Optional[StrictStr] = Field(default=None, description="the Runner Data Download URL")
+    state: Optional[RunnerJobState] = None
+    __properties: ClassVar[List[str]] = ["url", "state"]
+
+    model_config = {
+        "populate_by_name": 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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RunnerDataDownloadInfo 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "url",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunnerDataDownloadInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "url": obj.get("url"),
+            "state": obj.get("state")
+        })
+        return _obj
+
+

cosmotech_api/models/runner_data_download_job.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.2.0
+    Contact: platform@cosmotech.com
+    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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunnerDataDownloadJob(BaseModel):
+    """
+    Runner data download job
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="the Runner Data Download job identifier")
+    __properties: ClassVar[List[str]] = ["id"]
+
+    model_config = {
+        "populate_by_name": 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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RunnerDataDownloadJob 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunnerDataDownloadJob from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id")
+        })
+        return _obj
+
+

cosmotech_api/models/runner_job_state.py

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.2.0
+    Contact: platform@cosmotech.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class RunnerJobState(str, Enum):
+    """
+    the Runner job state
+    """
+
+    """
+    allowed enum values
+    """
+    CREATED = 'Created'
+    RUNNING = 'Running'
+    SUCCESSFUL = 'Successful'
+    FAILED = 'Failed'
+    UNKNOWN = 'Unknown'
+    DATAINGESTIONINPROGRESS = 'DataIngestionInProgress'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RunnerJobState from a JSON string"""
+        return cls(json.loads(json_str))
+
+

cosmotech_api/models/runner_last_run.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.2.0
+    Contact: platform@cosmotech.com
+    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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunnerLastRun(BaseModel):
+    """
+    RunnerLastRun
+    """ # noqa: E501
+    runner_run_id: Optional[StrictStr] = Field(default=None, description="the last Runner Run id", alias="runnerRunId")
+    csm_simulation_run: Optional[StrictStr] = Field(default=None, description="the last Cosmo Tech Simulation Run id", alias="csmSimulationRun")
+    workflow_id: Optional[StrictStr] = Field(default=None, description="the last Workflow Id", alias="workflowId")
+    workflow_name: Optional[StrictStr] = Field(default=None, description="the last Workflow name", alias="workflowName")
+    __properties: ClassVar[List[str]] = ["runnerRunId", "csmSimulationRun", "workflowId", "workflowName"]
+
+    model_config = {
+        "populate_by_name": 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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RunnerLastRun 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunnerLastRun from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "runnerRunId": obj.get("runnerRunId"),
+            "csmSimulationRun": obj.get("csmSimulationRun"),
+            "workflowId": obj.get("workflowId"),
+            "workflowName": obj.get("workflowName")
+        })
+        return _obj
+
+

cosmotech_api/models/runner_parent_last_run.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.2.0
+    Contact: platform@cosmotech.com
+    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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunnerParentLastRun(BaseModel):
+    """
+    RunnerParentLastRun
+    """ # noqa: E501
+    runner_run_id: Optional[StrictStr] = Field(default=None, description="the last Runner Run id", alias="runnerRunId")
+    csm_simulation_run: Optional[StrictStr] = Field(default=None, description="the last Cosmo Tech Simulation Run id", alias="csmSimulationRun")
+    workflow_id: Optional[StrictStr] = Field(default=None, description="the last Workflow Id", alias="workflowId")
+    workflow_name: Optional[StrictStr] = Field(default=None, description="the last Workflow name", alias="workflowName")
+    __properties: ClassVar[List[str]] = ["runnerRunId", "csmSimulationRun", "workflowId", "workflowName"]
+
+    model_config = {
+        "populate_by_name": 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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RunnerParentLastRun 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunnerParentLastRun from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "runnerRunId": obj.get("runnerRunId"),
+            "csmSimulationRun": obj.get("csmSimulationRun"),
+            "workflowId": obj.get("workflowId"),
+            "workflowName": obj.get("workflowName")
+        })
+        return _obj
+
+