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

cosmotech_api/models/run_template_parameter_group.py

@@ -0,0 +1,98 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class RunTemplateParameterGroup(BaseModel):
+    """
+    a Parameter Group for a Run Template
+    """ # noqa: E501
+    id: StrictStr = Field(description="the Parameter Group id")
+    labels: Optional[Dict[str, StrictStr]] = Field(default=None, description="a translated label with key as ISO 639-1 code")
+    is_table: Optional[StrictBool] = Field(default=None, description="does the group define a table", alias="isTable")
+    options: Optional[Dict[str, Any]] = Field(default=None, description="freeform options")
+    parent_id: Optional[StrictStr] = Field(default=None, description="the Run Template Group parent Id", alias="parentId")
+    parameters: Optional[List[StrictStr]] = Field(default=None, description="an ordered list of Run Template Parameters")
+    __properties: ClassVar[List[str]] = ["id", "labels", "isTable", "options", "parentId", "parameters"]
+
+    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 RunTemplateParameterGroup 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 RunTemplateParameterGroup 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"),
+            "labels": obj.get("labels"),
+            "isTable": obj.get("isTable"),
+            "options": obj.get("options"),
+            "parentId": obj.get("parentId"),
+            "parameters": obj.get("parameters")
+        })
+        return _obj
+
+

cosmotech_api/models/run_template_parameter_value.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 RunTemplateParameterValue(BaseModel):
+    """
+    the value of Analysis parameter for a Runner for this Run
+    """ # 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")
+    __properties: ClassVar[List[str]] = ["parameterId", "varType", "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 RunTemplateParameterValue 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 RunTemplateParameterValue 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")
+        })
+        return _obj
+
+

cosmotech_api/models/run_template_resource_sizing.py

@@ -0,0 +1,97 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from cosmotech_api.models.resource_size_info import ResourceSizeInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunTemplateResourceSizing(BaseModel):
+    """
+    a description object for resource requests and limits (default same configuration as basic sizing)
+    """ # noqa: E501
+    requests: ResourceSizeInfo
+    limits: ResourceSizeInfo
+    __properties: ClassVar[List[str]] = ["requests", "limits"]
+
+    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 RunTemplateResourceSizing 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 requests
+        if self.requests:
+            _dict['requests'] = self.requests.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of limits
+        if self.limits:
+            _dict['limits'] = self.limits.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunTemplateResourceSizing from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "requests": ResourceSizeInfo.from_dict(obj["requests"]) if obj.get("requests") is not None else None,
+            "limits": ResourceSizeInfo.from_dict(obj["limits"]) if obj.get("limits") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/run_template_step_source.py

@@ -0,0 +1,40 @@
+# 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 RunTemplateStepSource(str, Enum):
+    """
+    the source local, cloud or git repository
+    """
+
+    """
+    allowed enum values
+    """
+    CLOUD = 'cloud'
+    GIT = 'git'
+    LOCAL = 'local'
+    PLATFORM = 'platform'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RunTemplateStepSource from a JSON string"""
+        return cls(json.loads(json_str))
+
+

cosmotech_api/models/runner.py

@@ -0,0 +1,188 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.runner_job_state import RunnerJobState
+from cosmotech_api.models.runner_last_run import RunnerLastRun
+from cosmotech_api.models.runner_parent_last_run import RunnerParentLastRun
+from cosmotech_api.models.runner_resource_sizing import RunnerResourceSizing
+from cosmotech_api.models.runner_root_last_run import RunnerRootLastRun
+from cosmotech_api.models.runner_run_template_parameter_value import RunnerRunTemplateParameterValue
+from cosmotech_api.models.runner_security import RunnerSecurity
+from cosmotech_api.models.runner_validation_status import RunnerValidationStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Runner(BaseModel):
+    """
+    a Runner with base information
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="the Runner unique identifier")
+    name: Optional[StrictStr] = Field(default=None, description="the Runner name")
+    description: Optional[StrictStr] = Field(default=None, description="the Runner description")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="the list of tags")
+    parent_id: Optional[StrictStr] = Field(default=None, description="the Runner parent id", alias="parentId")
+    owner_id: Optional[StrictStr] = Field(default=None, description="the user id which own this Runner", alias="ownerId")
+    root_id: Optional[StrictStr] = Field(default=None, description="the runner root id", alias="rootId")
+    solution_id: Optional[StrictStr] = Field(default=None, description="the Solution Id associated with this Runner", alias="solutionId")
+    run_template_id: Optional[StrictStr] = Field(default=None, description="the Solution Run Template Id associated with this Runner", alias="runTemplateId")
+    organization_id: Optional[StrictStr] = Field(default=None, description="the associated Organization Id", alias="organizationId")
+    workspace_id: Optional[StrictStr] = Field(default=None, description="the associated Workspace Id", alias="workspaceId")
+    state: Optional[RunnerJobState] = None
+    creation_date: Optional[StrictInt] = Field(default=None, description="the Runner creation date", alias="creationDate")
+    last_update: Optional[StrictInt] = Field(default=None, description="the last time a Runner was updated", alias="lastUpdate")
+    owner_name: Optional[StrictStr] = Field(default=None, description="the name of the owner", alias="ownerName")
+    solution_name: Optional[StrictStr] = Field(default=None, description="the Solution name", alias="solutionName")
+    run_template_name: Optional[StrictStr] = Field(default=None, description="the Solution Run Template name associated with this Runner", alias="runTemplateName")
+    dataset_list: Optional[List[StrictStr]] = Field(default=None, description="the list of Dataset Id associated to this Runner Run Template", alias="datasetList")
+    run_sizing: Optional[RunnerResourceSizing] = Field(default=None, alias="runSizing")
+    parameters_values: Optional[List[RunnerRunTemplateParameterValue]] = Field(default=None, description="the list of Solution Run Template parameters values", alias="parametersValues")
+    last_run: Optional[RunnerLastRun] = Field(default=None, alias="lastRun")
+    parent_last_run: Optional[RunnerParentLastRun] = Field(default=None, alias="parentLastRun")
+    root_last_run: Optional[RunnerRootLastRun] = Field(default=None, alias="rootLastRun")
+    validation_status: Optional[RunnerValidationStatus] = Field(default=None, alias="validationStatus")
+    security: Optional[RunnerSecurity] = None
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "tags", "parentId", "ownerId", "rootId", "solutionId", "runTemplateId", "organizationId", "workspaceId", "state", "creationDate", "lastUpdate", "ownerName", "solutionName", "runTemplateName", "datasetList", "runSizing", "parametersValues", "lastRun", "parentLastRun", "rootLastRun", "validationStatus", "security"]
+
+    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 Runner 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.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+            "owner_id",
+            "root_id",
+            "solution_id",
+            "organization_id",
+            "workspace_id",
+            "creation_date",
+            "last_update",
+            "owner_name",
+            "solution_name",
+            "run_template_name",
+        ])
+
+        _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 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 last_run
+        if self.last_run:
+            _dict['lastRun'] = self.last_run.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of parent_last_run
+        if self.parent_last_run:
+            _dict['parentLastRun'] = self.parent_last_run.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of root_last_run
+        if self.root_last_run:
+            _dict['rootLastRun'] = self.root_last_run.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of security
+        if self.security:
+            _dict['security'] = self.security.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Runner 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"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "parentId": obj.get("parentId"),
+            "ownerId": obj.get("ownerId"),
+            "rootId": obj.get("rootId"),
+            "solutionId": obj.get("solutionId"),
+            "runTemplateId": obj.get("runTemplateId"),
+            "organizationId": obj.get("organizationId"),
+            "workspaceId": obj.get("workspaceId"),
+            "state": obj.get("state"),
+            "creationDate": obj.get("creationDate"),
+            "lastUpdate": obj.get("lastUpdate"),
+            "ownerName": obj.get("ownerName"),
+            "solutionName": obj.get("solutionName"),
+            "runTemplateName": obj.get("runTemplateName"),
+            "datasetList": obj.get("datasetList"),
+            "runSizing": RunnerResourceSizing.from_dict(obj["runSizing"]) if obj.get("runSizing") is not None else None,
+            "parametersValues": [RunnerRunTemplateParameterValue.from_dict(_item) for _item in obj["parametersValues"]] if obj.get("parametersValues") is not None else None,
+            "lastRun": RunnerLastRun.from_dict(obj["lastRun"]) if obj.get("lastRun") is not None else None,
+            "parentLastRun": RunnerParentLastRun.from_dict(obj["parentLastRun"]) if obj.get("parentLastRun") is not None else None,
+            "rootLastRun": RunnerRootLastRun.from_dict(obj["rootLastRun"]) if obj.get("rootLastRun") is not None else None,
+            "validationStatus": obj.get("validationStatus"),
+            "security": RunnerSecurity.from_dict(obj["security"]) if obj.get("security") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/runner_access_control.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 RunnerAccessControl(BaseModel):
+    """
+    a Runner access control item
+    """ # noqa: E501
+    id: StrictStr = Field(description="the identity id")
+    role: StrictStr = Field(description="a role")
+    __properties: ClassVar[List[str]] = ["id", "role"]
+
+    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 RunnerAccessControl 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 RunnerAccessControl 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"),
+            "role": obj.get("role")
+        })
+        return _obj
+
+