gamsapi 52.5.0__cp312-cp312-win_amd64.whl

gams/engine/models/model_instance_pool_info.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from gams.engine.models.model_instance_info import ModelInstanceInfo
+from gams.engine.models.model_user import ModelUser
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelInstancePoolInfo(BaseModel):
+    """
+    ModelInstancePoolInfo
+    """ # noqa: E501
+    cancelling: Optional[StrictBool] = None
+    instance: Optional[ModelInstanceInfo] = None
+    label: Optional[StrictStr] = None
+    owner: Optional[ModelUser] = None
+    size: Optional[StrictInt] = None
+    size_active: Optional[StrictInt] = None
+    size_busy: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["cancelling", "instance", "label", "owner", "size", "size_active", "size_busy"]
+
+    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 ModelInstancePoolInfo 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 instance
+        if self.instance:
+            _dict['instance'] = self.instance.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of owner
+        if self.owner:
+            _dict['owner'] = self.owner.to_dict()
+        # set to None if instance (nullable) is None
+        # and model_fields_set contains the field
+        if self.instance is None and "instance" in self.model_fields_set:
+            _dict['instance'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelInstancePoolInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "cancelling": obj.get("cancelling"),
+            "instance": ModelInstanceInfo.from_dict(obj["instance"]) if obj.get("instance") is not None else None,
+            "label": obj.get("label"),
+            "owner": ModelUser.from_dict(obj["owner"]) if obj.get("owner") is not None else None,
+            "size": obj.get("size"),
+            "size_active": obj.get("size_active"),
+            "size_busy": obj.get("size_busy")
+        })
+        return _obj
+
+

gams/engine/models/model_job_labels.py

@@ -0,0 +1,179 @@
+# coding: utf-8
+
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from gams.engine.models.generic_key_value_pair import GenericKeyValuePair
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelJobLabels(BaseModel):
+    """
+    ModelJobLabels
+    """ # noqa: E501
+    cpu_request: Optional[Union[StrictFloat, StrictInt]] = None
+    instance: Optional[StrictStr] = None
+    memory_request: Optional[StrictInt] = None
+    multiplier: Optional[Union[StrictFloat, StrictInt]] = None
+    node_selectors: Optional[List[GenericKeyValuePair]] = None
+    resource_warning: Optional[StrictStr] = None
+    tolerations: Optional[List[GenericKeyValuePair]] = None
+    workspace_request: Optional[StrictInt] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["cpu_request", "instance", "memory_request", "multiplier", "node_selectors", "resource_warning", "tolerations", "workspace_request"]
+
+    @field_validator('resource_warning')
+    def resource_warning_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['none', 'disk', 'memory']):
+            raise ValueError("must be one of enum values ('none', 'disk', 'memory')")
+        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 ModelJobLabels 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _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 node_selectors (list)
+        _items = []
+        if self.node_selectors:
+            for _item_node_selectors in self.node_selectors:
+                if _item_node_selectors:
+                    _items.append(_item_node_selectors.to_dict())
+            _dict['node_selectors'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in tolerations (list)
+        _items = []
+        if self.tolerations:
+            for _item_tolerations in self.tolerations:
+                if _item_tolerations:
+                    _items.append(_item_tolerations.to_dict())
+            _dict['tolerations'] = _items
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if cpu_request (nullable) is None
+        # and model_fields_set contains the field
+        if self.cpu_request is None and "cpu_request" in self.model_fields_set:
+            _dict['cpu_request'] = None
+
+        # set to None if instance (nullable) is None
+        # and model_fields_set contains the field
+        if self.instance is None and "instance" in self.model_fields_set:
+            _dict['instance'] = None
+
+        # set to None if memory_request (nullable) is None
+        # and model_fields_set contains the field
+        if self.memory_request is None and "memory_request" in self.model_fields_set:
+            _dict['memory_request'] = None
+
+        # set to None if multiplier (nullable) is None
+        # and model_fields_set contains the field
+        if self.multiplier is None and "multiplier" in self.model_fields_set:
+            _dict['multiplier'] = None
+
+        # set to None if node_selectors (nullable) is None
+        # and model_fields_set contains the field
+        if self.node_selectors is None and "node_selectors" in self.model_fields_set:
+            _dict['node_selectors'] = None
+
+        # set to None if resource_warning (nullable) is None
+        # and model_fields_set contains the field
+        if self.resource_warning is None and "resource_warning" in self.model_fields_set:
+            _dict['resource_warning'] = None
+
+        # set to None if tolerations (nullable) is None
+        # and model_fields_set contains the field
+        if self.tolerations is None and "tolerations" in self.model_fields_set:
+            _dict['tolerations'] = None
+
+        # set to None if workspace_request (nullable) is None
+        # and model_fields_set contains the field
+        if self.workspace_request is None and "workspace_request" in self.model_fields_set:
+            _dict['workspace_request'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelJobLabels from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "cpu_request": obj.get("cpu_request"),
+            "instance": obj.get("instance"),
+            "memory_request": obj.get("memory_request"),
+            "multiplier": obj.get("multiplier"),
+            "node_selectors": [GenericKeyValuePair.from_dict(_item) for _item in obj["node_selectors"]] if obj.get("node_selectors") is not None else None,
+            "resource_warning": obj.get("resource_warning"),
+            "tolerations": [GenericKeyValuePair.from_dict(_item) for _item in obj["tolerations"]] if obj.get("tolerations") is not None else None,
+            "workspace_request": obj.get("workspace_request")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

gams/engine/models/model_job_usage.py

@@ -0,0 +1,133 @@
+# coding: utf-8
+
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from gams.engine.models.model_job_labels import ModelJobLabels
+from gams.engine.models.time_span import TimeSpan
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelJobUsage(BaseModel):
+    """
+    ModelJobUsage
+    """ # noqa: E501
+    finished: Optional[datetime] = None
+    labels: Optional[ModelJobLabels] = None
+    model: Optional[StrictStr] = None
+    namespace: Optional[StrictStr] = None
+    process_status: Optional[StrictInt] = None
+    status: Optional[StrictInt] = None
+    submitted: Optional[datetime] = None
+    times: Optional[List[TimeSpan]] = None
+    token: Optional[StrictStr] = None
+    username: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["finished", "labels", "model", "namespace", "process_status", "status", "submitted", "times", "token", "username"]
+
+    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 ModelJobUsage 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 labels
+        if self.labels:
+            _dict['labels'] = self.labels.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in times (list)
+        _items = []
+        if self.times:
+            for _item_times in self.times:
+                if _item_times:
+                    _items.append(_item_times.to_dict())
+            _dict['times'] = _items
+        # set to None if finished (nullable) is None
+        # and model_fields_set contains the field
+        if self.finished is None and "finished" in self.model_fields_set:
+            _dict['finished'] = None
+
+        # set to None if labels (nullable) is None
+        # and model_fields_set contains the field
+        if self.labels is None and "labels" in self.model_fields_set:
+            _dict['labels'] = None
+
+        # set to None if process_status (nullable) is None
+        # and model_fields_set contains the field
+        if self.process_status is None and "process_status" in self.model_fields_set:
+            _dict['process_status'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelJobUsage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "finished": obj.get("finished"),
+            "labels": ModelJobLabels.from_dict(obj["labels"]) if obj.get("labels") is not None else None,
+            "model": obj.get("model"),
+            "namespace": obj.get("namespace"),
+            "process_status": obj.get("process_status"),
+            "status": obj.get("status"),
+            "submitted": obj.get("submitted"),
+            "times": [TimeSpan.from_dict(_item) for _item in obj["times"]] if obj.get("times") is not None else None,
+            "token": obj.get("token"),
+            "username": obj.get("username")
+        })
+        return _obj
+
+

gams/engine/models/model_pool_usage.py

@@ -0,0 +1,124 @@
+# coding: utf-8
+
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from gams.engine.models.model_instance_info import ModelInstanceInfo
+from gams.engine.models.model_user import ModelUser
+from gams.engine.models.time_span_pool_worker import TimeSpanPoolWorker
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelPoolUsage(BaseModel):
+    """
+    ModelPoolUsage
+    """ # noqa: E501
+    created_at: Optional[datetime] = None
+    deleted_at: Optional[datetime] = None
+    instance: Optional[ModelInstanceInfo] = None
+    label: Optional[StrictStr] = None
+    owner: Optional[ModelUser] = None
+    times: Optional[List[TimeSpanPoolWorker]] = None
+    __properties: ClassVar[List[str]] = ["created_at", "deleted_at", "instance", "label", "owner", "times"]
+
+    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 ModelPoolUsage 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 instance
+        if self.instance:
+            _dict['instance'] = self.instance.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of owner
+        if self.owner:
+            _dict['owner'] = self.owner.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in times (list)
+        _items = []
+        if self.times:
+            for _item_times in self.times:
+                if _item_times:
+                    _items.append(_item_times.to_dict())
+            _dict['times'] = _items
+        # set to None if deleted_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.deleted_at is None and "deleted_at" in self.model_fields_set:
+            _dict['deleted_at'] = None
+
+        # set to None if instance (nullable) is None
+        # and model_fields_set contains the field
+        if self.instance is None and "instance" in self.model_fields_set:
+            _dict['instance'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelPoolUsage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "created_at": obj.get("created_at"),
+            "deleted_at": obj.get("deleted_at"),
+            "instance": ModelInstanceInfo.from_dict(obj["instance"]) if obj.get("instance") is not None else None,
+            "label": obj.get("label"),
+            "owner": ModelUser.from_dict(obj["owner"]) if obj.get("owner") is not None else None,
+            "times": [TimeSpanPoolWorker.from_dict(_item) for _item in obj["times"]] if obj.get("times") is not None else None
+        })
+        return _obj
+
+

gams/engine/models/model_usage.py

@@ -0,0 +1,115 @@
+# coding: utf-8
+
+"""
+    GAMS Engine
+
+    With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
+
+    The version of the OpenAPI document: latest
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from gams.engine.models.model_hypercube_usage import ModelHypercubeUsage
+from gams.engine.models.model_job_usage import ModelJobUsage
+from gams.engine.models.model_pool_usage import ModelPoolUsage
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelUsage(BaseModel):
+    """
+    ModelUsage
+    """ # noqa: E501
+    hypercube_job_usage: Optional[List[ModelHypercubeUsage]] = None
+    job_usage: Optional[List[ModelJobUsage]] = None
+    pool_usage: Optional[List[ModelPoolUsage]] = None
+    __properties: ClassVar[List[str]] = ["hypercube_job_usage", "job_usage", "pool_usage"]
+
+    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 ModelUsage 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 hypercube_job_usage (list)
+        _items = []
+        if self.hypercube_job_usage:
+            for _item_hypercube_job_usage in self.hypercube_job_usage:
+                if _item_hypercube_job_usage:
+                    _items.append(_item_hypercube_job_usage.to_dict())
+            _dict['hypercube_job_usage'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in job_usage (list)
+        _items = []
+        if self.job_usage:
+            for _item_job_usage in self.job_usage:
+                if _item_job_usage:
+                    _items.append(_item_job_usage.to_dict())
+            _dict['job_usage'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in pool_usage (list)
+        _items = []
+        if self.pool_usage:
+            for _item_pool_usage in self.pool_usage:
+                if _item_pool_usage:
+                    _items.append(_item_pool_usage.to_dict())
+            _dict['pool_usage'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelUsage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "hypercube_job_usage": [ModelHypercubeUsage.from_dict(_item) for _item in obj["hypercube_job_usage"]] if obj.get("hypercube_job_usage") is not None else None,
+            "job_usage": [ModelJobUsage.from_dict(_item) for _item in obj["job_usage"]] if obj.get("job_usage") is not None else None,
+            "pool_usage": [ModelPoolUsage.from_dict(_item) for _item in obj["pool_usage"]] if obj.get("pool_usage") is not None else None
+        })
+        return _obj
+
+