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

cosmotech_api/models/run_state.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 RunState(str, Enum):
+    """
+    the Run end-to-end state
+    """
+
+    """
+    allowed enum values
+    """
+    RUNNING = 'Running'
+    SUCCESSFUL = 'Successful'
+    FAILED = 'Failed'
+    UNKNOWN = 'Unknown'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RunState from a JSON string"""
+        return cls(json.loads(json_str))
+
+

cosmotech_api/models/run_status.py

@@ -0,0 +1,123 @@
+# 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.run_state import RunState
+from cosmotech_api.models.run_status_node import RunStatusNode
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunStatus(BaseModel):
+    """
+    a Run status
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="the Run id")
+    organization_id: Optional[StrictStr] = Field(default=None, description="the Organization id", alias="organizationId")
+    workspace_id: Optional[StrictStr] = Field(default=None, description="the Workspace id", alias="workspaceId")
+    runner_id: Optional[StrictStr] = Field(default=None, description="the Runner id", alias="runnerId")
+    workflow_id: Optional[StrictStr] = Field(default=None, description="the Cosmo Tech compute cluster Argo Workflow Id to search", alias="workflowId")
+    workflow_name: Optional[StrictStr] = Field(default=None, description="the Cosmo Tech compute cluster Argo Workflow Name", alias="workflowName")
+    start_time: Optional[StrictStr] = Field(default=None, description="the Run start Date Time", alias="startTime")
+    end_time: Optional[StrictStr] = Field(default=None, description="the Run end Date Time", alias="endTime")
+    phase: Optional[StrictStr] = Field(default=None, description="high-level summary of where the workflow is in its lifecycle")
+    progress: Optional[StrictStr] = Field(default=None, description="progress to completion")
+    message: Optional[StrictStr] = Field(default=None, description="a  human readable message indicating details about why the workflow is in this condition")
+    estimated_duration: Optional[StrictInt] = Field(default=None, description="estimatedDuration in seconds", alias="estimatedDuration")
+    nodes: Optional[List[RunStatusNode]] = Field(default=None, description="status of Run nodes")
+    state: Optional[RunState] = None
+    __properties: ClassVar[List[str]] = ["id", "organizationId", "workspaceId", "runnerId", "workflowId", "workflowName", "startTime", "endTime", "phase", "progress", "message", "estimatedDuration", "nodes", "state"]
+
+    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 RunStatus 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 nodes (list)
+        _items = []
+        if self.nodes:
+            for _item in self.nodes:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['nodes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunStatus 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"),
+            "organizationId": obj.get("organizationId"),
+            "workspaceId": obj.get("workspaceId"),
+            "runnerId": obj.get("runnerId"),
+            "workflowId": obj.get("workflowId"),
+            "workflowName": obj.get("workflowName"),
+            "startTime": obj.get("startTime"),
+            "endTime": obj.get("endTime"),
+            "phase": obj.get("phase"),
+            "progress": obj.get("progress"),
+            "message": obj.get("message"),
+            "estimatedDuration": obj.get("estimatedDuration"),
+            "nodes": [RunStatusNode.from_dict(_item) for _item in obj["nodes"]] if obj.get("nodes") is not None else None,
+            "state": obj.get("state")
+        })
+        return _obj
+
+

cosmotech_api/models/run_status_node.py

@@ -0,0 +1,116 @@
+# 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.run_resource_requested import RunResourceRequested
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunStatusNode(BaseModel):
+    """
+    status of a Run Node
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="the node id")
+    name: Optional[StrictStr] = Field(default=None, description="the node unique name")
+    container_name: Optional[StrictStr] = Field(default=None, description="the Run container name", alias="containerName")
+    outbound_nodes: Optional[List[StrictStr]] = Field(default=None, description="the list of outbound nodes", alias="outboundNodes")
+    resources_duration: Optional[RunResourceRequested] = Field(default=None, alias="resourcesDuration")
+    estimated_duration: Optional[StrictInt] = Field(default=None, description="estimatedDuration in seconds", alias="estimatedDuration")
+    host_node_name: Optional[StrictStr] = Field(default=None, description="HostNodeName name of the Kubernetes node on which the Pod is running, if applicable", alias="hostNodeName")
+    message: Optional[StrictStr] = Field(default=None, description="a human readable message indicating details about why the node is in this condition")
+    phase: Optional[StrictStr] = Field(default=None, description="high-level summary of where the node is in its lifecycle")
+    progress: Optional[StrictStr] = Field(default=None, description="progress to completion")
+    start_time: Optional[StrictStr] = Field(default=None, description="the node start time", alias="startTime")
+    end_time: Optional[StrictStr] = Field(default=None, description="the node end time", alias="endTime")
+    __properties: ClassVar[List[str]] = ["id", "name", "containerName", "outboundNodes", "resourcesDuration", "estimatedDuration", "hostNodeName", "message", "phase", "progress", "startTime", "endTime"]
+
+    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 RunStatusNode 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([
+            "outbound_nodes",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of resources_duration
+        if self.resources_duration:
+            _dict['resourcesDuration'] = self.resources_duration.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunStatusNode 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"),
+            "containerName": obj.get("containerName"),
+            "outboundNodes": obj.get("outboundNodes"),
+            "resourcesDuration": RunResourceRequested.from_dict(obj["resourcesDuration"]) if obj.get("resourcesDuration") is not None else None,
+            "estimatedDuration": obj.get("estimatedDuration"),
+            "hostNodeName": obj.get("hostNodeName"),
+            "message": obj.get("message"),
+            "phase": obj.get("phase"),
+            "progress": obj.get("progress"),
+            "startTime": obj.get("startTime"),
+            "endTime": obj.get("endTime")
+        })
+        return _obj
+
+

cosmotech_api/models/run_template.py

@@ -0,0 +1,164 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.delete_historical_data import DeleteHistoricalData
+from cosmotech_api.models.run_template_orchestrator import RunTemplateOrchestrator
+from cosmotech_api.models.run_template_resource_sizing import RunTemplateResourceSizing
+from cosmotech_api.models.run_template_step_source import RunTemplateStepSource
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RunTemplate(BaseModel):
+    """
+    a Solution Run Template
+    """ # noqa: E501
+    id: StrictStr = Field(description="the Solution Run Template id")
+    name: Optional[StrictStr] = Field(default=None, description="the Run Template name")
+    labels: Optional[Dict[str, StrictStr]] = Field(default=None, description="a translated label with key as ISO 639-1 code")
+    description: Optional[StrictStr] = Field(default=None, description="the Run Template description")
+    csm_simulation: Optional[StrictStr] = Field(default=None, description="the Cosmo Tech simulation name. This information is send to the Engine. Mandatory information if no Engine is defined", alias="csmSimulation")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="the list of Run Template tags")
+    compute_size: Optional[StrictStr] = Field(default=None, description="the compute size needed for this Run Template. Standard sizes are basic and highcpu. Default is basic", alias="computeSize")
+    run_sizing: Optional[RunTemplateResourceSizing] = Field(default=None, alias="runSizing")
+    no_data_ingestion_state: Optional[StrictBool] = Field(default=None, description="set to true if the run template does not want to check data ingestion state (no probes or not control plane)", alias="noDataIngestionState")
+    fetch_datasets: Optional[StrictBool] = Field(default=None, description="whether or not the fetch dataset step is done", alias="fetchDatasets")
+    scenario_data_download_transform: Optional[StrictBool] = Field(default=None, description="whether or not the scenario data download transform step step is done", alias="scenarioDataDownloadTransform")
+    fetch_scenario_parameters: Optional[StrictBool] = Field(default=None, description="whether or not the fetch parameters step is done", alias="fetchScenarioParameters")
+    apply_parameters: Optional[StrictBool] = Field(default=None, description="whether or not the apply parameter step is done", alias="applyParameters")
+    validate_data: Optional[StrictBool] = Field(default=None, description="whether or not the validate step is done", alias="validateData")
+    send_datasets_to_data_warehouse: Optional[StrictBool] = Field(default=None, description="whether or not the Datasets values are send to the DataWarehouse prior to Simulation Run. If not set follow the Workspace setting", alias="sendDatasetsToDataWarehouse")
+    send_input_parameters_to_data_warehouse: Optional[StrictBool] = Field(default=None, description="whether or not the input parameters values are send to the DataWarehouse prior to Simulation Run. If not set follow the Workspace setting", alias="sendInputParametersToDataWarehouse")
+    pre_run: Optional[StrictBool] = Field(default=None, description="whether or not the pre-run step is done", alias="preRun")
+    run: Optional[StrictBool] = Field(default=None, description="whether or not the run step is done")
+    post_run: Optional[StrictBool] = Field(default=None, description="whether or not the post-run step is done", alias="postRun")
+    parameters_json: Optional[StrictBool] = Field(default=None, description="whether or not to store the scenario parameters in json instead of csv", alias="parametersJson")
+    parameters_handler_source: Optional[RunTemplateStepSource] = Field(default=None, alias="parametersHandlerSource")
+    dataset_validator_source: Optional[RunTemplateStepSource] = Field(default=None, alias="datasetValidatorSource")
+    pre_run_source: Optional[RunTemplateStepSource] = Field(default=None, alias="preRunSource")
+    run_source: Optional[RunTemplateStepSource] = Field(default=None, alias="runSource")
+    post_run_source: Optional[RunTemplateStepSource] = Field(default=None, alias="postRunSource")
+    scenariodata_transform_source: Optional[RunTemplateStepSource] = Field(default=None, alias="scenariodataTransformSource")
+    parameter_groups: Optional[List[StrictStr]] = Field(default=None, description="the ordered list of parameters groups for the Run Template", alias="parameterGroups")
+    stack_steps: Optional[StrictBool] = Field(default=None, description="whether or not to stack adjacent scenario run steps in one container run which will chain steps", alias="stackSteps")
+    git_repository_url: Optional[StrictStr] = Field(default=None, description="an optional URL to the git repository", alias="gitRepositoryUrl")
+    git_branch_name: Optional[StrictStr] = Field(default=None, description="an optional git branch name", alias="gitBranchName")
+    run_template_source_dir: Optional[StrictStr] = Field(default=None, description="an optional directory where to find the run template source", alias="runTemplateSourceDir")
+    orchestrator_type: Optional[RunTemplateOrchestrator] = Field(default=None, alias="orchestratorType")
+    execution_timeout: Optional[StrictInt] = Field(default=None, description="an optional duration in seconds in which a workflow is allowed to run", alias="executionTimeout")
+    delete_historical_data: Optional[DeleteHistoricalData] = Field(default=None, alias="deleteHistoricalData")
+    __properties: ClassVar[List[str]] = ["id", "name", "labels", "description", "csmSimulation", "tags", "computeSize", "runSizing", "noDataIngestionState", "fetchDatasets", "scenarioDataDownloadTransform", "fetchScenarioParameters", "applyParameters", "validateData", "sendDatasetsToDataWarehouse", "sendInputParametersToDataWarehouse", "preRun", "run", "postRun", "parametersJson", "parametersHandlerSource", "datasetValidatorSource", "preRunSource", "runSource", "postRunSource", "scenariodataTransformSource", "parameterGroups", "stackSteps", "gitRepositoryUrl", "gitBranchName", "runTemplateSourceDir", "orchestratorType", "executionTimeout", "deleteHistoricalData"]
+
+    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 RunTemplate 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 run_sizing
+        if self.run_sizing:
+            _dict['runSizing'] = self.run_sizing.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of delete_historical_data
+        if self.delete_historical_data:
+            _dict['deleteHistoricalData'] = self.delete_historical_data.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RunTemplate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "labels": obj.get("labels"),
+            "description": obj.get("description"),
+            "csmSimulation": obj.get("csmSimulation"),
+            "tags": obj.get("tags"),
+            "computeSize": obj.get("computeSize"),
+            "runSizing": RunTemplateResourceSizing.from_dict(obj["runSizing"]) if obj.get("runSizing") is not None else None,
+            "noDataIngestionState": obj.get("noDataIngestionState"),
+            "fetchDatasets": obj.get("fetchDatasets"),
+            "scenarioDataDownloadTransform": obj.get("scenarioDataDownloadTransform"),
+            "fetchScenarioParameters": obj.get("fetchScenarioParameters"),
+            "applyParameters": obj.get("applyParameters"),
+            "validateData": obj.get("validateData"),
+            "sendDatasetsToDataWarehouse": obj.get("sendDatasetsToDataWarehouse"),
+            "sendInputParametersToDataWarehouse": obj.get("sendInputParametersToDataWarehouse"),
+            "preRun": obj.get("preRun"),
+            "run": obj.get("run"),
+            "postRun": obj.get("postRun"),
+            "parametersJson": obj.get("parametersJson"),
+            "parametersHandlerSource": obj.get("parametersHandlerSource"),
+            "datasetValidatorSource": obj.get("datasetValidatorSource"),
+            "preRunSource": obj.get("preRunSource"),
+            "runSource": obj.get("runSource"),
+            "postRunSource": obj.get("postRunSource"),
+            "scenariodataTransformSource": obj.get("scenariodataTransformSource"),
+            "parameterGroups": obj.get("parameterGroups"),
+            "stackSteps": obj.get("stackSteps"),
+            "gitRepositoryUrl": obj.get("gitRepositoryUrl"),
+            "gitBranchName": obj.get("gitBranchName"),
+            "runTemplateSourceDir": obj.get("runTemplateSourceDir"),
+            "orchestratorType": obj.get("orchestratorType"),
+            "executionTimeout": obj.get("executionTimeout"),
+            "deleteHistoricalData": DeleteHistoricalData.from_dict(obj["deleteHistoricalData"]) if obj.get("deleteHistoricalData") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/run_template_handler_id.py

@@ -0,0 +1,42 @@
+# 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 RunTemplateHandlerId(str, Enum):
+    """
+    the Run Template step handler identifier
+    """
+
+    """
+    allowed enum values
+    """
+    PARAMETERS_HANDLER = 'parameters_handler'
+    VALIDATOR = 'validator'
+    PRERUN = 'prerun'
+    ENGINE = 'engine'
+    POSTRUN = 'postrun'
+    SCENARIODATA_TRANSFORM = 'scenariodata_transform'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RunTemplateHandlerId from a JSON string"""
+        return cls(json.loads(json_str))
+
+

cosmotech_api/models/run_template_orchestrator.py

@@ -0,0 +1,38 @@
+# 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 RunTemplateOrchestrator(str, Enum):
+    """
+    the Orchestrator to use for the Run Template
+    """
+
+    """
+    allowed enum values
+    """
+    ARGOWORKFLOW = 'argoWorkflow'
+    CSMORC = 'csmOrc'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RunTemplateOrchestrator from a JSON string"""
+        return cls(json.loads(json_str))
+
+

cosmotech_api/models/run_template_parameter.py

@@ -0,0 +1,102 @@
+# 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 RunTemplateParameter(BaseModel):
+    """
+    a Run Template Parameter
+    """ # noqa: E501
+    id: StrictStr = Field(description="the Parameter id")
+    labels: Optional[Dict[str, StrictStr]] = Field(default=None, description="a translated label with key as ISO 639-1 code")
+    var_type: Optional[StrictStr] = Field(default=None, description="the variable type for the parameter. Basic types or special type %DATASETID%", alias="varType")
+    default_value: Optional[StrictStr] = Field(default=None, description="the default value for this parameter", alias="defaultValue")
+    min_value: Optional[StrictStr] = Field(default=None, description="the minimum value for this parameter", alias="minValue")
+    max_value: Optional[StrictStr] = Field(default=None, description="the maximum value for this parameter", alias="maxValue")
+    regex_validation: Optional[StrictStr] = Field(default=None, description="a regex to validate the value", alias="regexValidation")
+    options: Optional[Dict[str, Any]] = Field(default=None, description="freeform options")
+    __properties: ClassVar[List[str]] = ["id", "labels", "varType", "defaultValue", "minValue", "maxValue", "regexValidation", "options"]
+
+    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 RunTemplateParameter 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 RunTemplateParameter 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"),
+            "varType": obj.get("varType"),
+            "defaultValue": obj.get("defaultValue"),
+            "minValue": obj.get("minValue"),
+            "maxValue": obj.get("maxValue"),
+            "regexValidation": obj.get("regexValidation"),
+            "options": obj.get("options")
+        })
+        return _obj
+
+