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

cosmotech_api/models/run_container_artifact.py

@@ -0,0 +1,90 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class RunContainerArtifact(BaseModel):
+    """
+    a runner run container artifact
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, description="the artifact name")
+    path: Optional[StrictStr] = Field(default=None, description="the artifact path (relative to /var/csmoutput)")
+    __properties: ClassVar[List[str]] = ["name", "path"]
+
+    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 RunContainerArtifact 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 RunContainerArtifact from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "path": obj.get("path")
+        })
+        return _obj
+
+

cosmotech_api/models/run_container_logs.py

@@ -0,0 +1,102 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class RunContainerLogs(BaseModel):
+    """
+    logs for a given container
+    """ # noqa: E501
+    node_id: Optional[StrictStr] = Field(default=None, description="the node Id which has executed this log", alias="nodeId")
+    container_name: Optional[StrictStr] = Field(default=None, description="the container name", alias="containerName")
+    children: Optional[List[StrictStr]] = Field(default=None, description="the list of children node id")
+    logs: Optional[StrictStr] = Field(default=None, description="the node logs in plain text")
+    __properties: ClassVar[List[str]] = ["nodeId", "containerName", "children", "logs"]
+
+    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 RunContainerLogs 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([
+            "node_id",
+            "container_name",
+            "children",
+            "logs",
+        ])
+
+        _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 RunContainerLogs from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "nodeId": obj.get("nodeId"),
+            "containerName": obj.get("containerName"),
+            "children": obj.get("children"),
+            "logs": obj.get("logs")
+        })
+        return _obj
+
+

cosmotech_api/models/run_logs.py

@@ -0,0 +1,107 @@
+# 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.run_container_logs import RunContainerLogs
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunLogs(BaseModel):
+    """
+    the run logs returned by all containers
+    """ # noqa: E501
+    run_id: Optional[StrictStr] = Field(default=None, description="the Run Id", alias="runId")
+    containers: Optional[Dict[str, RunContainerLogs]] = Field(default=None, description="the container map of logs")
+    __properties: ClassVar[List[str]] = ["runId", "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 RunLogs 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.
+        """
+        excluded_fields: Set[str] = set([
+            "run_id",
+            "containers",
+        ])
+
+        _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 value in containers (dict)
+        _field_dict = {}
+        if self.containers:
+            for _key in self.containers:
+                if self.containers[_key]:
+                    _field_dict[_key] = self.containers[_key].to_dict()
+            _dict['containers'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunLogs from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "runId": obj.get("runId"),
+            "containers": dict(
+                (_k, RunContainerLogs.from_dict(_v))
+                for _k, _v in obj["containers"].items()
+            )
+            if obj.get("containers") is not None
+            else None
+        })
+        return _obj
+
+

cosmotech_api/models/run_resource_requested.py

@@ -0,0 +1,90 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunResourceRequested(BaseModel):
+    """
+    the memory and CPU requested by the pod
+    """ # noqa: E501
+    cpu: Optional[StrictInt] = Field(default=None, description="the cpu requested")
+    memory: Optional[StrictInt] = Field(default=None, description="the memory requested")
+    __properties: ClassVar[List[str]] = ["cpu", "memory"]
+
+    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 RunResourceRequested 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 RunResourceRequested from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "cpu": obj.get("cpu"),
+            "memory": obj.get("memory")
+        })
+        return _obj
+
+

cosmotech_api/models/run_search.py

@@ -0,0 +1,112 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunSearch(BaseModel):
+    """
+    the search options
+    """ # noqa: E501
+    solution_id: Optional[StrictStr] = Field(default=None, description="the Solution Id to search", alias="solutionId")
+    run_template_id: Optional[StrictStr] = Field(default=None, description="the Solution Analysis Id to search", alias="runTemplateId")
+    workspace_id: Optional[StrictStr] = Field(default=None, description="the Workspace Id to search", alias="workspaceId")
+    runner_id: Optional[StrictStr] = Field(default=None, description="the Runner Id to search", alias="runnerId")
+    state: Optional[StrictStr] = Field(default=None, description="the state to search")
+    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")
+    owner_id: Optional[StrictStr] = Field(default=None, description="the owner Id to search", alias="ownerId")
+    __properties: ClassVar[List[str]] = ["solutionId", "runTemplateId", "workspaceId", "runnerId", "state", "workflowId", "workflowName", "ownerId"]
+
+    @field_validator('state')
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['FetchingDatasets', 'FetchingScenarioParameters', 'ApplyingScenarioParameters', 'ValidatingScenarioData', 'SendingScenarioDataToDataWarehouse', 'PreRun', 'Running', 'PostRun', 'Success', 'Failed']):
+            raise ValueError("must be one of enum values ('FetchingDatasets', 'FetchingScenarioParameters', 'ApplyingScenarioParameters', 'ValidatingScenarioData', 'SendingScenarioDataToDataWarehouse', 'PreRun', 'Running', 'PostRun', 'Success', 'Failed')")
+        return value
+
+    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 RunSearch 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 RunSearch from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "solutionId": obj.get("solutionId"),
+            "runTemplateId": obj.get("runTemplateId"),
+            "workspaceId": obj.get("workspaceId"),
+            "runnerId": obj.get("runnerId"),
+            "state": obj.get("state"),
+            "workflowId": obj.get("workflowId"),
+            "workflowName": obj.get("workflowName"),
+            "ownerId": obj.get("ownerId")
+        })
+        return _obj
+
+

cosmotech_api/models/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.run_container import RunContainer
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunStartContainers(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[RunContainer] = 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 RunStartContainers 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 RunStartContainers 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": [RunContainer.from_dict(_item) for _item in obj["containers"]] if obj.get("containers") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/run_state.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 RunState(str, Enum):
+    """
+    the Run end-to-end state
+    """
+
+    """
+    allowed enum values
+    """
+    RUNNING = 'Running'
+    SUCCESSFUL = 'Successful'
+    FAILED = 'Failed'
+    UNKNOWN = 'Unknown'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RunState from a JSON string"""
+        return cls(json.loads(json_str))
+
+