cosmotech-api 4.0.0.dev9__py3-none-any.whl → 5.0.0b4__py3-none-any.whl

cosmotech_api/models/create_info.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-beta4
+    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, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateInfo(BaseModel):
+    """
+    CreateInfo
+    """ # noqa: E501
+    timestamp: StrictInt = Field(description="The timestamp of the creation in millisecond")
+    user_id: StrictStr = Field(description="The id of the user who did the creation", alias="userId")
+    runner_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The runner id which has created the dataset (nullable)", alias="runnerId")
+    __properties: ClassVar[List[str]] = ["timestamp", "userId", "runnerId"]
+
+    @field_validator('runner_id')
+    def runner_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^r-\w{10,20}", value):
+            raise ValueError(r"must validate the regular expression /^r-\w{10,20}/")
+        return value
+
+    model_config = ConfigDict(
+        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 CreateInfo 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 CreateInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "timestamp": obj.get("timestamp"),
+            "userId": obj.get("userId"),
+            "runnerId": obj.get("runnerId")
+        })
+        return _obj
+
+

cosmotech_api/models/created_run.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.9
+    The version of the OpenAPI document: 5.0.0-beta4
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -25,7 +25,7 @@ from typing_extensions import Self
 
 class CreatedRun(BaseModel):
     """
-    Newle created Run info
+    Newly created Run info
     """ # noqa: E501
     id: StrictStr = Field(description="Run id")
     __properties: ClassVar[List[str]] = ["id"]

cosmotech_api/models/dataset.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.9
+    The version of the OpenAPI document: 5.0.0-beta4
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,46 +18,38 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
-from cosmotech_api.models.dataset_compatibility import DatasetCompatibility
-from cosmotech_api.models.dataset_connector import DatasetConnector
+from typing_extensions import Annotated
+from cosmotech_api.models.create_info import CreateInfo
+from cosmotech_api.models.dataset_part import DatasetPart
 from cosmotech_api.models.dataset_security import DatasetSecurity
-from cosmotech_api.models.dataset_source_type import DatasetSourceType
-from cosmotech_api.models.ingestion_status_enum import IngestionStatusEnum
-from cosmotech_api.models.source_info import SourceInfo
-from cosmotech_api.models.twincache_status_enum import TwincacheStatusEnum
+from cosmotech_api.models.edit_info import EditInfo
 from typing import Optional, Set
 from typing_extensions import Self
 
 class Dataset(BaseModel):
     """
-    a Dataset
+    Dataset object
     """ # noqa: E501
-    id: Optional[StrictStr] = Field(default=None, description="the Dataset unique identifier")
-    name: Optional[StrictStr] = Field(default=None, description="the Dataset name")
-    description: Optional[StrictStr] = Field(default=None, description="the Dataset description")
-    owner_id: Optional[StrictStr] = Field(default=None, description="the User id which own this Dataset", alias="ownerId")
-    owner_name: Optional[StrictStr] = Field(default=None, description="the name of the owner", alias="ownerName")
-    organization_id: Optional[StrictStr] = Field(default=None, description="the Organization Id related to this Dataset", alias="organizationId")
-    parent_id: Optional[StrictStr] = Field(default=None, description="the Dataset id which is the parent of this Dataset", alias="parentId")
-    linked_workspace_id_list: Optional[List[StrictStr]] = Field(default=None, description="list of workspace linked to this dataset", alias="linkedWorkspaceIdList")
-    twingraph_id: Optional[StrictStr] = Field(default=None, description="the twin graph id", alias="twingraphId")
-    main: Optional[StrictBool] = Field(default=None, description="is this the main dataset")
-    creation_date: Optional[StrictInt] = Field(default=None, description="the Dataset creation date", alias="creationDate")
-    refresh_date: Optional[StrictInt] = Field(default=None, description="the last time a refresh was done", alias="refreshDate")
-    source_type: Optional[DatasetSourceType] = Field(default=None, alias="sourceType")
-    source: Optional[SourceInfo] = None
-    ingestion_status: Optional[IngestionStatusEnum] = Field(default=None, alias="ingestionStatus")
-    twincache_status: Optional[TwincacheStatusEnum] = Field(default=None, alias="twincacheStatus")
-    queries: Optional[List[StrictStr]] = Field(default=None, description="the list of queries")
-    tags: Optional[List[StrictStr]] = Field(default=None, description="the list of tags")
-    connector: Optional[DatasetConnector] = None
-    fragments_ids: Optional[List[StrictStr]] = Field(default=None, description="the list of other Datasets ids to compose as fragments", alias="fragmentsIds")
-    validator_id: Optional[StrictStr] = Field(default=None, description="the validator id", alias="validatorId")
-    compatibility: Optional[List[DatasetCompatibility]] = Field(default=None, description="the list of compatible Solutions versions")
-    security: Optional[DatasetSecurity] = None
-    __properties: ClassVar[List[str]] = ["id", "name", "description", "ownerId", "ownerName", "organizationId", "parentId", "linkedWorkspaceIdList", "twingraphId", "main", "creationDate", "refreshDate", "sourceType", "source", "ingestionStatus", "twincacheStatus", "queries", "tags", "connector", "fragmentsIds", "validatorId", "compatibility", "security"]
+    id: Annotated[str, Field(strict=True)]
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=50)]
+    description: Optional[StrictStr] = None
+    organization_id: StrictStr = Field(description="the associated Organization Id", alias="organizationId")
+    workspace_id: StrictStr = Field(description="the associated Workspace Id", alias="workspaceId")
+    tags: List[StrictStr] = Field(description="the list of tags")
+    parts: List[DatasetPart]
+    create_info: CreateInfo = Field(description="The details of the Dataset creation", alias="createInfo")
+    update_info: EditInfo = Field(description="The details of the Dataset last update", alias="updateInfo")
+    security: DatasetSecurity
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "organizationId", "workspaceId", "tags", "parts", "createInfo", "updateInfo", "security"]
+
+    @field_validator('id')
+    def id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^d-\w{10,20}", value):
+            raise ValueError(r"must validate the regular expression /^d-\w{10,20}/")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -91,18 +83,10 @@ class Dataset(BaseModel):
           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.
         """
         excluded_fields: Set[str] = set([
-            "id",
-            "owner_id",
-            "owner_name",
             "organization_id",
-            "creation_date",
-            "refresh_date",
+            "workspace_id",
         ])
 
         _dict = self.model_dump(
@@ -110,32 +94,22 @@ class Dataset(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of source
-        if self.source:
-            _dict['source'] = self.source.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of connector
-        if self.connector:
-            _dict['connector'] = self.connector.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of each item in compatibility (list)
+        # override the default output from pydantic by calling `to_dict()` of each item in parts (list)
         _items = []
-        if self.compatibility:
-            for _item_compatibility in self.compatibility:
-                if _item_compatibility:
-                    _items.append(_item_compatibility.to_dict())
-            _dict['compatibility'] = _items
+        if self.parts:
+            for _item_parts in self.parts:
+                if _item_parts:
+                    _items.append(_item_parts.to_dict())
+            _dict['parts'] = _items
+        # override the default output from pydantic by calling `to_dict()` of create_info
+        if self.create_info:
+            _dict['createInfo'] = self.create_info.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of update_info
+        if self.update_info:
+            _dict['updateInfo'] = self.update_info.to_dict()
         # override the default output from pydantic by calling `to_dict()` of security
         if self.security:
             _dict['security'] = self.security.to_dict()
-        # set to None if ingestion_status (nullable) is None
-        # and model_fields_set contains the field
-        if self.ingestion_status is None and "ingestion_status" in self.model_fields_set:
-            _dict['ingestionStatus'] = None
-
-        # set to None if twincache_status (nullable) is None
-        # and model_fields_set contains the field
-        if self.twincache_status is None and "twincache_status" in self.model_fields_set:
-            _dict['twincacheStatus'] = None
-
         return _dict
 
     @classmethod
@@ -151,25 +125,12 @@ class Dataset(BaseModel):
             "id": obj.get("id"),
             "name": obj.get("name"),
             "description": obj.get("description"),
-            "ownerId": obj.get("ownerId"),
-            "ownerName": obj.get("ownerName"),
             "organizationId": obj.get("organizationId"),
-            "parentId": obj.get("parentId"),
-            "linkedWorkspaceIdList": obj.get("linkedWorkspaceIdList"),
-            "twingraphId": obj.get("twingraphId"),
-            "main": obj.get("main"),
-            "creationDate": obj.get("creationDate"),
-            "refreshDate": obj.get("refreshDate"),
-            "sourceType": obj.get("sourceType"),
-            "source": SourceInfo.from_dict(obj["source"]) if obj.get("source") is not None else None,
-            "ingestionStatus": obj.get("ingestionStatus"),
-            "twincacheStatus": obj.get("twincacheStatus"),
-            "queries": obj.get("queries"),
+            "workspaceId": obj.get("workspaceId"),
             "tags": obj.get("tags"),
-            "connector": DatasetConnector.from_dict(obj["connector"]) if obj.get("connector") is not None else None,
-            "fragmentsIds": obj.get("fragmentsIds"),
-            "validatorId": obj.get("validatorId"),
-            "compatibility": [DatasetCompatibility.from_dict(_item) for _item in obj["compatibility"]] if obj.get("compatibility") is not None else None,
+            "parts": [DatasetPart.from_dict(_item) for _item in obj["parts"]] if obj.get("parts") is not None else None,
+            "createInfo": CreateInfo.from_dict(obj["createInfo"]) if obj.get("createInfo") is not None else None,
+            "updateInfo": EditInfo.from_dict(obj["updateInfo"]) if obj.get("updateInfo") is not None else None,
             "security": DatasetSecurity.from_dict(obj["security"]) if obj.get("security") is not None else None
         })
         return _obj

cosmotech_api/models/dataset_access_control.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.9
+    The version of the OpenAPI document: 5.0.0-beta4
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

cosmotech_api/models/dataset_compatibility.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.9
+    The version of the OpenAPI document: 5.0.1-SNAPSHOT
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

cosmotech_api/models/dataset_connector.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.9
+    The version of the OpenAPI document: 5.0.1-SNAPSHOT
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

cosmotech_api/models/dataset_copy_parameters.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.9
+    The version of the OpenAPI document: 5.0.1-SNAPSHOT
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

cosmotech_api/models/dataset_create_request.py

@@ -0,0 +1,121 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-beta4
+    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, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from cosmotech_api.models.dataset_part_create_request import DatasetPartCreateRequest
+from cosmotech_api.models.dataset_security import DatasetSecurity
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetCreateRequest(BaseModel):
+    """
+    Dataset creation request
+    """ # noqa: E501
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=50)]
+    description: Optional[StrictStr] = None
+    tags: Optional[List[StrictStr]] = None
+    parts: Optional[List[DatasetPartCreateRequest]] = None
+    security: Optional[DatasetSecurity] = None
+    runner_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, alias="runnerId")
+    __properties: ClassVar[List[str]] = ["name", "description", "tags", "parts", "security", "runnerId"]
+
+    @field_validator('runner_id')
+    def runner_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^r-\w{10,20}", value):
+            raise ValueError(r"must validate the regular expression /^r-\w{10,20}/")
+        return value
+
+    model_config = ConfigDict(
+        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 DatasetCreateRequest 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 parts (list)
+        _items = []
+        if self.parts:
+            for _item_parts in self.parts:
+                if _item_parts:
+                    _items.append(_item_parts.to_dict())
+            _dict['parts'] = _items
+        # 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 DatasetCreateRequest 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"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "parts": [DatasetPartCreateRequest.from_dict(_item) for _item in obj["parts"]] if obj.get("parts") is not None else None,
+            "security": DatasetSecurity.from_dict(obj["security"]) if obj.get("security") is not None else None,
+            "runnerId": obj.get("runnerId")
+        })
+        return _obj
+
+

cosmotech_api/models/dataset_part.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-beta4
+    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, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from cosmotech_api.models.dataset_part_type_enum import DatasetPartTypeEnum
+from cosmotech_api.models.edit_info import EditInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetPart(BaseModel):
+    """
+    Dataset part object
+    """ # noqa: E501
+    id: Annotated[str, Field(strict=True)]
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=50)]
+    source_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="the source data name (e.g. filename associated to the dataset part)", alias="sourceName")
+    description: Optional[StrictStr] = None
+    tags: List[StrictStr]
+    type: DatasetPartTypeEnum
+    organization_id: StrictStr = Field(description="the associated Organization Id", alias="organizationId")
+    workspace_id: StrictStr = Field(description="the associated Workspace Id", alias="workspaceId")
+    dataset_id: StrictStr = Field(description="the associated Dataset Id", alias="datasetId")
+    create_info: EditInfo = Field(description="The details of the Dataset creation", alias="createInfo")
+    update_info: EditInfo = Field(description="The details of the Dataset last update", alias="updateInfo")
+    __properties: ClassVar[List[str]] = ["id", "name", "sourceName", "description", "tags", "type", "organizationId", "workspaceId", "datasetId", "createInfo", "updateInfo"]
+
+    @field_validator('id')
+    def id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^dp-\w{10,20}", value):
+            raise ValueError(r"must validate the regular expression /^dp-\w{10,20}/")
+        return value
+
+    model_config = ConfigDict(
+        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 DatasetPart from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "organization_id",
+            "workspace_id",
+            "dataset_id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of create_info
+        if self.create_info:
+            _dict['createInfo'] = self.create_info.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of update_info
+        if self.update_info:
+            _dict['updateInfo'] = self.update_info.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetPart 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"),
+            "sourceName": obj.get("sourceName"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "type": obj.get("type") if obj.get("type") is not None else DatasetPartTypeEnum.RELATIONAL,
+            "organizationId": obj.get("organizationId"),
+            "workspaceId": obj.get("workspaceId"),
+            "datasetId": obj.get("datasetId"),
+            "createInfo": EditInfo.from_dict(obj["createInfo"]) if obj.get("createInfo") is not None else None,
+            "updateInfo": EditInfo.from_dict(obj["updateInfo"]) if obj.get("updateInfo") is not None else None
+        })
+        return _obj
+
+