gamsapi 52.2.0__cp314-cp314-win_amd64.whl → 52.4.0__cp314-cp314-win_amd64.whl

gams/engine/models/model_default_instance.py

@@ -0,0 +1,99 @@
+# 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, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelDefaultInstance(BaseModel):
+    """
+    ModelDefaultInstance
+    """ # noqa: E501
+    label: Optional[StrictStr] = None
+    resource_type: Optional[StrictStr] = Field(default=None, description="The type of computing resource")
+    __properties: ClassVar[List[str]] = ["label", "resource_type"]
+
+    @field_validator('resource_type')
+    def resource_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['instance', 'instance_pool']):
+            raise ValueError("must be one of enum values ('instance', 'instance_pool')")
+        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 ModelDefaultInstance 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 ModelDefaultInstance from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "label": obj.get("label"),
+            "resource_type": obj.get("resource_type")
+        })
+        return _obj
+
+

gams/engine/models/model_default_user_instance.py

@@ -0,0 +1,98 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from gams.engine.models.model_default_instance import ModelDefaultInstance
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelDefaultUserInstance(BaseModel):
+    """
+    ModelDefaultUserInstance
+    """ # noqa: E501
+    default_inherited_from: Optional[StrictStr] = None
+    default_instance: Optional[ModelDefaultInstance] = None
+    __properties: ClassVar[List[str]] = ["default_inherited_from", "default_instance"]
+
+    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 ModelDefaultUserInstance 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 default_instance
+        if self.default_instance:
+            _dict['default_instance'] = self.default_instance.to_dict()
+        # set to None if default_inherited_from (nullable) is None
+        # and model_fields_set contains the field
+        if self.default_inherited_from is None and "default_inherited_from" in self.model_fields_set:
+            _dict['default_inherited_from'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelDefaultUserInstance from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "default_inherited_from": obj.get("default_inherited_from"),
+            "default_instance": ModelDefaultInstance.from_dict(obj["default_instance"]) if obj.get("default_instance") is not None else None
+        })
+        return _obj
+
+

gams/engine/models/model_hypercube_job.py

@@ -0,0 +1,106 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from gams.engine.models.time_span import TimeSpan
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelHypercubeJob(BaseModel):
+    """
+    ModelHypercubeJob
+    """ # noqa: E501
+    job_number: Optional[StrictInt] = None
+    process_status: Optional[StrictInt] = None
+    status: Optional[StrictInt] = None
+    times: Optional[List[TimeSpan]] = None
+    __properties: ClassVar[List[str]] = ["job_number", "process_status", "status", "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 ModelHypercubeJob 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 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 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 ModelHypercubeJob from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_number": obj.get("job_number"),
+            "process_status": obj.get("process_status"),
+            "status": obj.get("status"),
+            "times": [TimeSpan.from_dict(_item) for _item in obj["times"]] if obj.get("times") is not None else None
+        })
+        return _obj
+
+

gams/engine/models/model_hypercube_usage.py

@@ -0,0 +1,130 @@
+# 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_hypercube_job import ModelHypercubeJob
+from gams.engine.models.model_job_labels import ModelJobLabels
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelHypercubeUsage(BaseModel):
+    """
+    ModelHypercubeUsage
+    """ # noqa: E501
+    completed: Optional[StrictInt] = None
+    finished: Optional[datetime] = None
+    job_count: Optional[StrictInt] = None
+    jobs: Optional[List[ModelHypercubeJob]] = None
+    labels: Optional[ModelJobLabels] = None
+    model: Optional[StrictStr] = None
+    namespace: Optional[StrictStr] = None
+    status: Optional[StrictInt] = None
+    submitted: Optional[datetime] = None
+    token: Optional[StrictStr] = None
+    username: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["completed", "finished", "job_count", "jobs", "labels", "model", "namespace", "status", "submitted", "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 ModelHypercubeUsage 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 jobs (list)
+        _items = []
+        if self.jobs:
+            for _item_jobs in self.jobs:
+                if _item_jobs:
+                    _items.append(_item_jobs.to_dict())
+            _dict['jobs'] = _items
+        # override the default output from pydantic by calling `to_dict()` of labels
+        if self.labels:
+            _dict['labels'] = self.labels.to_dict()
+        # 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelHypercubeUsage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "completed": obj.get("completed"),
+            "finished": obj.get("finished"),
+            "job_count": obj.get("job_count"),
+            "jobs": [ModelHypercubeJob.from_dict(_item) for _item in obj["jobs"]] if obj.get("jobs") is not None else None,
+            "labels": ModelJobLabels.from_dict(obj["labels"]) if obj.get("labels") is not None else None,
+            "model": obj.get("model"),
+            "namespace": obj.get("namespace"),
+            "status": obj.get("status"),
+            "submitted": obj.get("submitted"),
+            "token": obj.get("token"),
+            "username": obj.get("username")
+        })
+        return _obj
+
+

gams/engine/models/model_instance_info.py

@@ -0,0 +1,116 @@
+# 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
+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 ModelInstanceInfo(BaseModel):
+    """
+    ModelInstanceInfo
+    """ # noqa: E501
+    cpu_request: Optional[Union[StrictFloat, StrictInt]] = None
+    label: Optional[StrictStr] = None
+    memory_request: Optional[StrictInt] = None
+    multiplier: Optional[Union[StrictFloat, StrictInt]] = None
+    multiplier_idle: Optional[Union[StrictFloat, StrictInt]] = None
+    node_selectors: Optional[List[GenericKeyValuePair]] = None
+    tolerations: Optional[List[GenericKeyValuePair]] = None
+    workspace_request: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["cpu_request", "label", "memory_request", "multiplier", "multiplier_idle", "node_selectors", "tolerations", "workspace_request"]
+
+    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 ModelInstanceInfo 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 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
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelInstanceInfo 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"),
+            "label": obj.get("label"),
+            "memory_request": obj.get("memory_request"),
+            "multiplier": obj.get("multiplier"),
+            "multiplier_idle": obj.get("multiplier_idle"),
+            "node_selectors": [GenericKeyValuePair.from_dict(_item) for _item in obj["node_selectors"]] if obj.get("node_selectors") is not None else None,
+            "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")
+        })
+        return _obj
+
+

gams/engine/models/model_instance_info_full.py

@@ -0,0 +1,123 @@
+# 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
+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 ModelInstanceInfoFull(BaseModel):
+    """
+    ModelInstanceInfoFull
+    """ # noqa: E501
+    cpu_request: Optional[Union[StrictFloat, StrictInt]] = None
+    gams_license: Optional[StrictStr] = None
+    label: Optional[StrictStr] = None
+    memory_request: Optional[StrictInt] = None
+    multiplier: Optional[Union[StrictFloat, StrictInt]] = None
+    multiplier_idle: Optional[Union[StrictFloat, StrictInt]] = None
+    node_selectors: Optional[List[GenericKeyValuePair]] = None
+    tolerations: Optional[List[GenericKeyValuePair]] = None
+    workspace_request: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["cpu_request", "gams_license", "label", "memory_request", "multiplier", "multiplier_idle", "node_selectors", "tolerations", "workspace_request"]
+
+    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 ModelInstanceInfoFull 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 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
+        # set to None if gams_license (nullable) is None
+        # and model_fields_set contains the field
+        if self.gams_license is None and "gams_license" in self.model_fields_set:
+            _dict['gams_license'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelInstanceInfoFull 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"),
+            "gams_license": obj.get("gams_license"),
+            "label": obj.get("label"),
+            "memory_request": obj.get("memory_request"),
+            "multiplier": obj.get("multiplier"),
+            "multiplier_idle": obj.get("multiplier_idle"),
+            "node_selectors": [GenericKeyValuePair.from_dict(_item) for _item in obj["node_selectors"]] if obj.get("node_selectors") is not None else None,
+            "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")
+        })
+        return _obj
+
+