cosmotech-api 3.1.0__py3-none-any.whl → 3.1.1__py3-none-any.whl

cosmotech_api/models/scenario_run_start_containers.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.1.1-SNAPSHOT
+    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.scenario_run_container import ScenarioRunContainer
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScenarioRunStartContainers(BaseModel):
+    """
+    the parameters to run directly containers
+    """ # noqa: E501
+    generate_name: Optional[StrictStr] = Field(default=None, description="the base name for workflow name generation", alias="generateName")
+    csm_simulation_id: StrictStr = Field(description="Cosmo Tech Simulation Run Id", alias="csmSimulationId")
+    node_label: Optional[StrictStr] = Field(default=None, description="the node label request", alias="nodeLabel")
+    labels: Optional[Dict[str, StrictStr]] = Field(default=None, description="the workflow labels")
+    containers: List[ScenarioRunContainer] = Field(description="the containerslist")
+    __properties: ClassVar[List[str]] = ["generateName", "csmSimulationId", "nodeLabel", "labels", "containers"]
+
+    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 ScenarioRunStartContainers 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 containers (list)
+        _items = []
+        if self.containers:
+            for _item in self.containers:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['containers'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScenarioRunStartContainers from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "generateName": obj.get("generateName"),
+            "csmSimulationId": obj.get("csmSimulationId"),
+            "nodeLabel": obj.get("nodeLabel"),
+            "labels": obj.get("labels"),
+            "containers": [ScenarioRunContainer.from_dict(_item) for _item in obj["containers"]] if obj.get("containers") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/scenario_run_state.py

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.1.1-SNAPSHOT
+    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 ScenarioRunState(str, Enum):
+    """
+    the ScenarioRun end-to-end state
+    """
+
+    """
+    allowed enum values
+    """
+    RUNNING = 'Running'
+    SUCCESSFUL = 'Successful'
+    FAILED = 'Failed'
+    UNKNOWN = 'Unknown'
+    DATAINGESTIONINPROGRESS = 'DataIngestionInProgress'
+    DATAINGESTIONFAILURE = 'DataIngestionFailure'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ScenarioRunState from a JSON string"""
+        return cls(json.loads(json_str))
+
+

cosmotech_api/models/scenario_run_status.py

@@ -0,0 +1,119 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.1.1-SNAPSHOT
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.scenario_run_state import ScenarioRunState
+from cosmotech_api.models.scenario_run_status_node import ScenarioRunStatusNode
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScenarioRunStatus(BaseModel):
+    """
+    a ScenarioRun status
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="the ScenarioRun id")
+    organization_id: Optional[StrictStr] = Field(default=None, description="the ScenarioRun id", alias="organizationId")
+    workflow_id: Optional[StrictStr] = Field(default=None, description="the Cosmo Tech compute cluster Argo Workflow Id to search", alias="workflowId")
+    workflow_name: Optional[StrictStr] = Field(default=None, description="the Cosmo Tech compute cluster Argo Workflow Name", alias="workflowName")
+    start_time: Optional[StrictStr] = Field(default=None, description="the ScenarioRun start Date Time", alias="startTime")
+    end_time: Optional[StrictStr] = Field(default=None, description="the ScenarioRun end Date Time", alias="endTime")
+    phase: Optional[StrictStr] = Field(default=None, description="high-level summary of where the workflow is in its lifecycle")
+    progress: Optional[StrictStr] = Field(default=None, description="progress to completion")
+    message: Optional[StrictStr] = Field(default=None, description="a  human readable message indicating details about why the workflow is in this condition")
+    estimated_duration: Optional[StrictInt] = Field(default=None, description="estimatedDuration in seconds", alias="estimatedDuration")
+    nodes: Optional[List[ScenarioRunStatusNode]] = Field(default=None, description="status of ScenarioRun nodes")
+    state: Optional[ScenarioRunState] = None
+    __properties: ClassVar[List[str]] = ["id", "organizationId", "workflowId", "workflowName", "startTime", "endTime", "phase", "progress", "message", "estimatedDuration", "nodes", "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 ScenarioRunStatus 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 nodes (list)
+        _items = []
+        if self.nodes:
+            for _item in self.nodes:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['nodes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScenarioRunStatus 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"),
+            "organizationId": obj.get("organizationId"),
+            "workflowId": obj.get("workflowId"),
+            "workflowName": obj.get("workflowName"),
+            "startTime": obj.get("startTime"),
+            "endTime": obj.get("endTime"),
+            "phase": obj.get("phase"),
+            "progress": obj.get("progress"),
+            "message": obj.get("message"),
+            "estimatedDuration": obj.get("estimatedDuration"),
+            "nodes": [ScenarioRunStatusNode.from_dict(_item) for _item in obj["nodes"]] if obj.get("nodes") is not None else None,
+            "state": obj.get("state")
+        })
+        return _obj
+
+

cosmotech_api/models/scenario_run_status_node.py

@@ -0,0 +1,116 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.1.1-SNAPSHOT
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.scenario_run_resource_requested import ScenarioRunResourceRequested
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScenarioRunStatusNode(BaseModel):
+    """
+    status of a ScenarioRun Node
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="the node id")
+    name: Optional[StrictStr] = Field(default=None, description="the node unique name")
+    container_name: Optional[StrictStr] = Field(default=None, description="the ScenarioRun container name", alias="containerName")
+    outbound_nodes: Optional[List[StrictStr]] = Field(default=None, description="the list of outbound nodes", alias="outboundNodes")
+    resources_duration: Optional[ScenarioRunResourceRequested] = Field(default=None, alias="resourcesDuration")
+    estimated_duration: Optional[StrictInt] = Field(default=None, description="estimatedDuration in seconds", alias="estimatedDuration")
+    host_node_name: Optional[StrictStr] = Field(default=None, description="HostNodeName name of the Kubernetes node on which the Pod is running, if applicable", alias="hostNodeName")
+    message: Optional[StrictStr] = Field(default=None, description="a human readable message indicating details about why the node is in this condition")
+    phase: Optional[StrictStr] = Field(default=None, description="high-level summary of where the node is in its lifecycle")
+    progress: Optional[StrictStr] = Field(default=None, description="progress to completion")
+    start_time: Optional[StrictStr] = Field(default=None, description="the node start time", alias="startTime")
+    end_time: Optional[StrictStr] = Field(default=None, description="the node end time", alias="endTime")
+    __properties: ClassVar[List[str]] = ["id", "name", "containerName", "outboundNodes", "resourcesDuration", "estimatedDuration", "hostNodeName", "message", "phase", "progress", "startTime", "endTime"]
+
+    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 ScenarioRunStatusNode 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([
+            "outbound_nodes",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of resources_duration
+        if self.resources_duration:
+            _dict['resourcesDuration'] = self.resources_duration.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScenarioRunStatusNode 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"),
+            "name": obj.get("name"),
+            "containerName": obj.get("containerName"),
+            "outboundNodes": obj.get("outboundNodes"),
+            "resourcesDuration": ScenarioRunResourceRequested.from_dict(obj["resourcesDuration"]) if obj.get("resourcesDuration") is not None else None,
+            "estimatedDuration": obj.get("estimatedDuration"),
+            "hostNodeName": obj.get("hostNodeName"),
+            "message": obj.get("message"),
+            "phase": obj.get("phase"),
+            "progress": obj.get("progress"),
+            "startTime": obj.get("startTime"),
+            "endTime": obj.get("endTime")
+        })
+        return _obj
+
+

cosmotech_api/models/scenario_run_template_parameter_value.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.1.1-SNAPSHOT
+    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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScenarioRunTemplateParameterValue(BaseModel):
+    """
+    the value of a Solution Run Template parameter for a Scenario
+    """ # noqa: E501
+    parameter_id: StrictStr = Field(description="the parameter Id", alias="parameterId")
+    var_type: Optional[StrictStr] = Field(default=None, description="the parameter value type", alias="varType")
+    value: StrictStr = Field(description="the parameter value")
+    is_inherited: Optional[StrictBool] = Field(default=None, description="whether or not the value is inherited from parent or has been changed", alias="isInherited")
+    __properties: ClassVar[List[str]] = ["parameterId", "varType", "value", "isInherited"]
+
+    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 ScenarioRunTemplateParameterValue 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([
+            "var_type",
+        ])
+
+        _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 ScenarioRunTemplateParameterValue 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"),
+            "isInherited": obj.get("isInherited")
+        })
+        return _obj
+
+

cosmotech_api/models/scenario_security.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.1.1-SNAPSHOT
+    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
+from cosmotech_api.models.scenario_access_control import ScenarioAccessControl
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScenarioSecurity(BaseModel):
+    """
+    the Scenario security information
+    """ # noqa: E501
+    default: StrictStr = Field(description="the role by default")
+    access_control_list: List[ScenarioAccessControl] = Field(description="the list which can access this Scenario with detailed access control information", alias="accessControlList")
+    __properties: ClassVar[List[str]] = ["default", "accessControlList"]
+
+    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 ScenarioSecurity 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 access_control_list (list)
+        _items = []
+        if self.access_control_list:
+            for _item in self.access_control_list:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['accessControlList'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScenarioSecurity from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "default": obj.get("default"),
+            "accessControlList": [ScenarioAccessControl.from_dict(_item) for _item in obj["accessControlList"]] if obj.get("accessControlList") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/scenario_validation_status.py

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.1.1-SNAPSHOT
+    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 ScenarioValidationStatus(str, Enum):
+    """
+    the validation status of the scenario
+    """
+
+    """
+    allowed enum values
+    """
+    DRAFT = 'Draft'
+    REJECTED = 'Rejected'
+    UNKNOWN = 'Unknown'
+    VALIDATED = 'Validated'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ScenarioValidationStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+