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

cosmotech_api/models/organization_services.py

@@ -0,0 +1,99 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.organization_service import OrganizationService
+from typing import Optional, Set
+from typing_extensions import Self
+
+class OrganizationServices(BaseModel):
+    """
+    the cloud service resources of the Organization
+    """ # noqa: E501
+    tenant_credentials: Optional[Dict[str, Any]] = Field(default=None, description="a freeform credentials object for the Organization tenant. Structure depends on cloud provider", alias="tenantCredentials")
+    storage: Optional[OrganizationService] = None
+    solutions_container_registry: Optional[OrganizationService] = Field(default=None, alias="solutionsContainerRegistry")
+    __properties: ClassVar[List[str]] = ["tenantCredentials", "storage", "solutionsContainerRegistry"]
+
+    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 OrganizationServices 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 storage
+        if self.storage:
+            _dict['storage'] = self.storage.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of solutions_container_registry
+        if self.solutions_container_registry:
+            _dict['solutionsContainerRegistry'] = self.solutions_container_registry.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of OrganizationServices from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tenantCredentials": obj.get("tenantCredentials"),
+            "storage": OrganizationService.from_dict(obj["storage"]) if obj.get("storage") is not None else None,
+            "solutionsContainerRegistry": OrganizationService.from_dict(obj["solutionsContainerRegistry"]) if obj.get("solutionsContainerRegistry") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/query_result.py

@@ -0,0 +1,88 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QueryResult(BaseModel):
+    """
+    the result of a SQL Query
+    """ # noqa: E501
+    result: Optional[List[Dict[str, Any]]] = Field(default=None, description="the list of results")
+    __properties: ClassVar[List[str]] = ["result"]
+
+    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 QueryResult 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 QueryResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "result": obj.get("result")
+        })
+        return _obj
+
+

cosmotech_api/models/resource_size_info.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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ResourceSizeInfo(BaseModel):
+    """
+    define cpus and memory needs
+    """ # noqa: E501
+    cpu: StrictStr = Field(description="define cpu needs")
+    memory: StrictStr = Field(description="define memory needs")
+    __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 ResourceSizeInfo 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 ResourceSizeInfo 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.py

@@ -0,0 +1,167 @@
+# 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.run_container import RunContainer
+from cosmotech_api.models.run_state import RunState
+from cosmotech_api.models.run_template_parameter_value import RunTemplateParameterValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Run(BaseModel):
+    """
+    a Run with only base properties
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="the Run")
+    state: Optional[RunState] = None
+    organization_id: Optional[StrictStr] = Field(default=None, description="the Organization id", alias="organizationId")
+    workflow_id: Optional[StrictStr] = Field(default=None, description="the Cosmo Tech compute cluster Argo Workflow Id to search", alias="workflowId")
+    csm_simulation_run: Optional[StrictStr] = Field(default=None, description="the Cosmo Tech Simulation Run Id", alias="csmSimulationRun")
+    generate_name: Optional[StrictStr] = Field(default=None, description="the base name for workflow name generation", alias="generateName")
+    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 user id which own this run", alias="ownerId")
+    workspace_id: Optional[StrictStr] = Field(default=None, description="the Workspace Id", alias="workspaceId")
+    workspace_key: Optional[StrictStr] = Field(default=None, description="technical key for resource name convention and version grouping. Must be unique", alias="workspaceKey")
+    runner_id: Optional[StrictStr] = Field(default=None, description="the Runner Id", alias="runnerId")
+    solution_id: Optional[StrictStr] = Field(default=None, description="the Solution Id", alias="solutionId")
+    run_template_id: Optional[StrictStr] = Field(default=None, description="the Solution Run Template id", alias="runTemplateId")
+    compute_size: Optional[StrictStr] = Field(default=None, description="the compute size needed for this Analysis. Standard sizes are basic and highcpu. Default is basic", alias="computeSize")
+    created_at: Optional[StrictStr] = Field(default=None, description="the Run creation date", alias="createdAt")
+    dataset_list: Optional[List[StrictStr]] = Field(default=None, description="the list of Dataset Id associated to this Run", alias="datasetList")
+    parameters_values: Optional[List[RunTemplateParameterValue]] = Field(default=None, description="the list of Run Template parameters values", alias="parametersValues")
+    node_label: Optional[StrictStr] = Field(default=None, description="the node label request", alias="nodeLabel")
+    containers: Optional[List[RunContainer]] = Field(default=None, description="the containers list. This information is not returned by the API.")
+    __properties: ClassVar[List[str]] = ["id", "state", "organizationId", "workflowId", "csmSimulationRun", "generateName", "workflowName", "ownerId", "workspaceId", "workspaceKey", "runnerId", "solutionId", "runTemplateId", "computeSize", "createdAt", "datasetList", "parametersValues", "nodeLabel", "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 Run 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * 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([
+            "id",
+            "csm_simulation_run",
+            "owner_id",
+            "workspace_id",
+            "workspace_key",
+            "runner_id",
+            "solution_id",
+            "run_template_id",
+            "compute_size",
+            "created_at",
+            "dataset_list",
+            "parameters_values",
+            "node_label",
+        ])
+
+        _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 parameters_values (list)
+        _items = []
+        if self.parameters_values:
+            for _item in self.parameters_values:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['parametersValues'] = _items
+        # 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 Run 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"),
+            "state": obj.get("state"),
+            "organizationId": obj.get("organizationId"),
+            "workflowId": obj.get("workflowId"),
+            "csmSimulationRun": obj.get("csmSimulationRun"),
+            "generateName": obj.get("generateName"),
+            "workflowName": obj.get("workflowName"),
+            "ownerId": obj.get("ownerId"),
+            "workspaceId": obj.get("workspaceId"),
+            "workspaceKey": obj.get("workspaceKey"),
+            "runnerId": obj.get("runnerId"),
+            "solutionId": obj.get("solutionId"),
+            "runTemplateId": obj.get("runTemplateId"),
+            "computeSize": obj.get("computeSize"),
+            "createdAt": obj.get("createdAt"),
+            "datasetList": obj.get("datasetList"),
+            "parametersValues": [RunTemplateParameterValue.from_dict(_item) for _item in obj["parametersValues"]] if obj.get("parametersValues") is not None else None,
+            "nodeLabel": obj.get("nodeLabel"),
+            "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_container.py

@@ -0,0 +1,126 @@
+# 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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.container_resource_sizing import ContainerResourceSizing
+from cosmotech_api.models.run_container_artifact import RunContainerArtifact
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunContainer(BaseModel):
+    """
+    a Run container description
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="the container Id")
+    name: StrictStr = Field(description="the container name")
+    labels: Optional[Dict[str, StrictStr]] = Field(default=None, description="the metadata labels")
+    env_vars: Optional[Dict[str, StrictStr]] = Field(default=None, description="environment variable map", alias="envVars")
+    image: StrictStr = Field(description="the container image URI")
+    entrypoint: Optional[StrictStr] = Field(default=None, description="the container entry point")
+    run_args: Optional[List[StrictStr]] = Field(default=None, description="the list of run arguments for the container", alias="runArgs")
+    dependencies: Optional[List[StrictStr]] = Field(default=None, description="the list of dependencies container name to run this container")
+    solution_container: Optional[StrictBool] = Field(default=None, description="whether or not this container is a Cosmo Tech solution container", alias="solutionContainer")
+    node_label: Optional[StrictStr] = Field(default=None, description="the node label request", alias="nodeLabel")
+    run_sizing: Optional[ContainerResourceSizing] = Field(default=None, alias="runSizing")
+    artifacts: Optional[List[RunContainerArtifact]] = Field(default=None, description="the list of artifacts")
+    __properties: ClassVar[List[str]] = ["id", "name", "labels", "envVars", "image", "entrypoint", "runArgs", "dependencies", "solutionContainer", "nodeLabel", "runSizing", "artifacts"]
+
+    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 RunContainer 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([
+            "id",
+            "solution_container",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of run_sizing
+        if self.run_sizing:
+            _dict['runSizing'] = self.run_sizing.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in artifacts (list)
+        _items = []
+        if self.artifacts:
+            for _item in self.artifacts:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['artifacts'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunContainer 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"),
+            "labels": obj.get("labels"),
+            "envVars": obj.get("envVars"),
+            "image": obj.get("image"),
+            "entrypoint": obj.get("entrypoint"),
+            "runArgs": obj.get("runArgs"),
+            "dependencies": obj.get("dependencies"),
+            "solutionContainer": obj.get("solutionContainer"),
+            "nodeLabel": obj.get("nodeLabel"),
+            "runSizing": ContainerResourceSizing.from_dict(obj["runSizing"]) if obj.get("runSizing") is not None else None,
+            "artifacts": [RunContainerArtifact.from_dict(_item) for _item in obj["artifacts"]] if obj.get("artifacts") is not None else None
+        })
+        return _obj
+
+

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.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 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
+
+