terra-scientific-pipelines-service-api-client 0.0.0__py3-none-any.whl

teaspoons_client/models/pipeline_with_details.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    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
+from typing import Any, ClassVar, Dict, List
+from teaspoons_client.models.pipeline_user_provided_input_definition import PipelineUserProvidedInputDefinition
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PipelineWithDetails(BaseModel):
+    """
+    Object containing the pipeline identifier, display name, description, type, and required inputs of a Pipeline. 
+    """ # noqa: E501
+    pipeline_name: StrictStr = Field(description="The identifier string for the Pipeline. ", alias="pipelineName")
+    display_name: StrictStr = Field(description="The display name for the Pipeline. ", alias="displayName")
+    description: StrictStr = Field(description="The description for the Pipeline. ")
+    type: StrictStr = Field(description="The general type of the Pipeline. ")
+    inputs: List[PipelineUserProvidedInputDefinition] = Field(description="A list of user-provided input fields and specifications for the Pipeline. ")
+    __properties: ClassVar[List[str]] = ["pipelineName", "displayName", "description", "type", "inputs"]
+
+    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 PipelineWithDetails 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 inputs (list)
+        _items = []
+        if self.inputs:
+            for _item_inputs in self.inputs:
+                if _item_inputs:
+                    _items.append(_item_inputs.to_dict())
+            _dict['inputs'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PipelineWithDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "pipelineName": obj.get("pipelineName"),
+            "displayName": obj.get("displayName"),
+            "description": obj.get("description"),
+            "type": obj.get("type"),
+            "inputs": [PipelineUserProvidedInputDefinition.from_dict(_item) for _item in obj["inputs"]] if obj.get("inputs") is not None else None
+        })
+        return _obj
+
+

teaspoons_client/models/prepare_pipeline_run_request_body.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PreparePipelineRunRequestBody(BaseModel):
+    """
+    Object containing the user-provided information defining a pipeline run request. 
+    """ # noqa: E501
+    job_id: StrictStr = Field(description="Required unique identifier (UUID) for a job. ", alias="jobId")
+    pipeline_version: StrictInt = Field(description="An identifier Integer for the Pipeline Version. ", alias="pipelineVersion")
+    pipeline_inputs: Dict[str, Dict[str, Any]] = Field(description="A map(string:object) of user-provided inputs for the Pipeline. ", alias="pipelineInputs")
+    __properties: ClassVar[List[str]] = ["jobId", "pipelineVersion", "pipelineInputs"]
+
+    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 PreparePipelineRunRequestBody 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 PreparePipelineRunRequestBody from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "jobId": obj.get("jobId"),
+            "pipelineVersion": obj.get("pipelineVersion"),
+            "pipelineInputs": obj.get("pipelineInputs")
+        })
+        return _obj
+
+

teaspoons_client/models/prepare_pipeline_run_response.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PreparePipelineRunResponse(BaseModel):
+    """
+    Result of the preparePipelineRun request, containing signed URLs to upload input files
+    """ # noqa: E501
+    job_id: Optional[StrictStr] = Field(default=None, description="Required unique identifier (UUID) for a job. ", alias="jobId")
+    file_input_upload_urls: Optional[Dict[str, Dict[str, StrictStr]]] = Field(default=None, alias="fileInputUploadUrls")
+    __properties: ClassVar[List[str]] = ["jobId", "fileInputUploadUrls"]
+
+    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 PreparePipelineRunResponse 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 PreparePipelineRunResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "jobId": obj.get("jobId"),
+            "fileInputUploadUrls": obj.get("fileInputUploadUrls")
+        })
+        return _obj
+
+

teaspoons_client/models/start_pipeline_run_request_body.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from teaspoons_client.models.job_control import JobControl
+from typing import Optional, Set
+from typing_extensions import Self
+
+class StartPipelineRunRequestBody(BaseModel):
+    """
+    Object containing the user-provided information defining a pipeline run request. 
+    """ # noqa: E501
+    description: Optional[StrictStr] = Field(default=None, description="User-provided description of the pipeline run.")
+    job_control: JobControl = Field(alias="jobControl")
+    __properties: ClassVar[List[str]] = ["description", "jobControl"]
+
+    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 StartPipelineRunRequestBody 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 job_control
+        if self.job_control:
+            _dict['jobControl'] = self.job_control.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of StartPipelineRunRequestBody from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "description": obj.get("description"),
+            "jobControl": JobControl.from_dict(obj["jobControl"]) if obj.get("jobControl") is not None else None
+        })
+        return _obj
+
+

teaspoons_client/models/system_status.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictBool
+from typing import Any, ClassVar, Dict, List
+from teaspoons_client.models.system_status_systems_value import SystemStatusSystemsValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SystemStatus(BaseModel):
+    """
+    SystemStatus
+    """ # noqa: E501
+    ok: StrictBool = Field(description="whether any system(s) need attention")
+    systems: Dict[str, SystemStatusSystemsValue]
+    __properties: ClassVar[List[str]] = ["ok", "systems"]
+
+    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 SystemStatus 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 value in systems (dict)
+        _field_dict = {}
+        if self.systems:
+            for _key_systems in self.systems:
+                if self.systems[_key_systems]:
+                    _field_dict[_key_systems] = self.systems[_key_systems].to_dict()
+            _dict['systems'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SystemStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ok": obj.get("ok"),
+            "systems": dict(
+                (_k, SystemStatusSystemsValue.from_dict(_v))
+                for _k, _v in obj["systems"].items()
+            )
+            if obj.get("systems") is not None
+            else None
+        })
+        return _obj
+
+

teaspoons_client/models/system_status_systems_value.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SystemStatusSystemsValue(BaseModel):
+    """
+    SystemStatusSystemsValue
+    """ # noqa: E501
+    ok: Optional[StrictBool] = None
+    messages: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["ok", "messages"]
+
+    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 SystemStatusSystemsValue 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 SystemStatusSystemsValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ok": obj.get("ok"),
+            "messages": obj.get("messages")
+        })
+        return _obj
+
+

teaspoons_client/models/update_pipeline_request_body.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdatePipelineRequestBody(BaseModel):
+    """
+    json object containing the admin provided information to update a pipeline with 
+    """ # noqa: E501
+    workspace_billing_project: StrictStr = Field(description="The Terra billing project of the workspace to run the pipeline in. ", alias="workspaceBillingProject")
+    workspace_name: StrictStr = Field(description="The name of the workspace to run the pipeline in. ", alias="workspaceName")
+    wdl_method_version: StrictStr = Field(description="An identifier string for the Pipeline Wdl Version i.e. github repo tag/branch/release ", alias="wdlMethodVersion")
+    __properties: ClassVar[List[str]] = ["workspaceBillingProject", "workspaceName", "wdlMethodVersion"]
+
+    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 UpdatePipelineRequestBody 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 UpdatePipelineRequestBody from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "workspaceBillingProject": obj.get("workspaceBillingProject"),
+            "workspaceName": obj.get("workspaceName"),
+            "wdlMethodVersion": obj.get("wdlMethodVersion")
+        })
+        return _obj
+
+