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

teaspoons_client/models/__init__.py

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    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
+
+
+# import models into model package
+from teaspoons_client.models.admin_pipeline import AdminPipeline
+from teaspoons_client.models.admin_quota import AdminQuota
+from teaspoons_client.models.async_pipeline_run_response import AsyncPipelineRunResponse
+from teaspoons_client.models.error_report import ErrorReport
+from teaspoons_client.models.get_jobs_response import GetJobsResponse
+from teaspoons_client.models.get_pipeline_details_request_body import GetPipelineDetailsRequestBody
+from teaspoons_client.models.get_pipeline_runs_response import GetPipelineRunsResponse
+from teaspoons_client.models.get_pipelines_result import GetPipelinesResult
+from teaspoons_client.models.job_control import JobControl
+from teaspoons_client.models.job_report import JobReport
+from teaspoons_client.models.job_result import JobResult
+from teaspoons_client.models.pipeline import Pipeline
+from teaspoons_client.models.pipeline_run import PipelineRun
+from teaspoons_client.models.pipeline_run_report import PipelineRunReport
+from teaspoons_client.models.pipeline_user_provided_input_definition import PipelineUserProvidedInputDefinition
+from teaspoons_client.models.pipeline_with_details import PipelineWithDetails
+from teaspoons_client.models.prepare_pipeline_run_request_body import PreparePipelineRunRequestBody
+from teaspoons_client.models.prepare_pipeline_run_response import PreparePipelineRunResponse
+from teaspoons_client.models.quota_with_details import QuotaWithDetails
+from teaspoons_client.models.start_pipeline_run_request_body import StartPipelineRunRequestBody
+from teaspoons_client.models.system_status import SystemStatus
+from teaspoons_client.models.system_status_systems_value import SystemStatusSystemsValue
+from teaspoons_client.models.update_pipeline_request_body import UpdatePipelineRequestBody
+from teaspoons_client.models.update_quota_limit_request_body import UpdateQuotaLimitRequestBody
+from teaspoons_client.models.version_properties import VersionProperties

teaspoons_client/models/admin_pipeline.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AdminPipeline(BaseModel):
+    """
+    Object containing the pipeline identifier, version, display name, description, and control workspace information for a Pipeline. 
+    """ # noqa: E501
+    pipeline_name: StrictStr = Field(description="The identifier string for the Pipeline. ", alias="pipelineName")
+    pipeline_version: StrictInt = Field(description="An identifier Integer for the Pipeline Version. ", alias="pipelineVersion")
+    display_name: StrictStr = Field(description="The display name for the Pipeline. ", alias="displayName")
+    description: StrictStr = Field(description="The description for the Pipeline. ")
+    wdl_method_version: StrictStr = Field(description="An identifier string for the Pipeline Wdl Version i.e. github repo tag/branch/release ", alias="wdlMethodVersion")
+    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")
+    workspace_storage_container_name: StrictStr = Field(description="The name of the workspace storage container (e.g. google bucket name, without gs:// prefix). ", alias="workspaceStorageContainerName")
+    workspace_google_project: StrictStr = Field(description="The google project of the workspace to run the pipeline in. ", alias="workspaceGoogleProject")
+    __properties: ClassVar[List[str]] = ["pipelineName", "pipelineVersion", "displayName", "description", "wdlMethodVersion", "workspaceBillingProject", "workspaceName", "workspaceStorageContainerName", "workspaceGoogleProject"]
+
+    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 AdminPipeline 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 AdminPipeline 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"),
+            "pipelineVersion": obj.get("pipelineVersion"),
+            "displayName": obj.get("displayName"),
+            "description": obj.get("description"),
+            "wdlMethodVersion": obj.get("wdlMethodVersion"),
+            "workspaceBillingProject": obj.get("workspaceBillingProject"),
+            "workspaceName": obj.get("workspaceName"),
+            "workspaceStorageContainerName": obj.get("workspaceStorageContainerName"),
+            "workspaceGoogleProject": obj.get("workspaceGoogleProject")
+        })
+        return _obj
+
+

teaspoons_client/models/admin_quota.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AdminQuota(BaseModel):
+    """
+    Object containing the use id, pipeline identifier, quota limit, and quota usage of a Pipeline for a user. 
+    """ # noqa: E501
+    user_id: StrictStr = Field(description="The identifier string for the user who submitted a job request. ", alias="userId")
+    pipeline_name: StrictStr = Field(description="The identifier string for the Pipeline. ", alias="pipelineName")
+    quota_limit: StrictInt = Field(description="Maximum allowable quota for the pipeline ", alias="quotaLimit")
+    quota_consumed: StrictInt = Field(description="Quota consumed by the user ", alias="quotaConsumed")
+    __properties: ClassVar[List[str]] = ["userId", "pipelineName", "quotaLimit", "quotaConsumed"]
+
+    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 AdminQuota 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 AdminQuota from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "userId": obj.get("userId"),
+            "pipelineName": obj.get("pipelineName"),
+            "quotaLimit": obj.get("quotaLimit"),
+            "quotaConsumed": obj.get("quotaConsumed")
+        })
+        return _obj
+
+

teaspoons_client/models/async_pipeline_run_response.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
+from typing import Any, ClassVar, Dict, List, Optional
+from teaspoons_client.models.error_report import ErrorReport
+from teaspoons_client.models.job_report import JobReport
+from teaspoons_client.models.pipeline_run_report import PipelineRunReport
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AsyncPipelineRunResponse(BaseModel):
+    """
+    Result of an asynchronous pipeline run request.
+    """ # noqa: E501
+    job_report: JobReport = Field(alias="jobReport")
+    error_report: Optional[ErrorReport] = Field(default=None, alias="errorReport")
+    pipeline_run_report: PipelineRunReport = Field(alias="pipelineRunReport")
+    __properties: ClassVar[List[str]] = ["jobReport", "errorReport", "pipelineRunReport"]
+
+    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 AsyncPipelineRunResponse 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_report
+        if self.job_report:
+            _dict['jobReport'] = self.job_report.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of error_report
+        if self.error_report:
+            _dict['errorReport'] = self.error_report.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pipeline_run_report
+        if self.pipeline_run_report:
+            _dict['pipelineRunReport'] = self.pipeline_run_report.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AsyncPipelineRunResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "jobReport": JobReport.from_dict(obj["jobReport"]) if obj.get("jobReport") is not None else None,
+            "errorReport": ErrorReport.from_dict(obj["errorReport"]) if obj.get("errorReport") is not None else None,
+            "pipelineRunReport": PipelineRunReport.from_dict(obj["pipelineRunReport"]) if obj.get("pipelineRunReport") is not None else None
+        })
+        return _obj
+
+

teaspoons_client/models/error_report.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 ErrorReport(BaseModel):
+    """
+    ErrorReport
+    """ # noqa: E501
+    message: StrictStr
+    status_code: StrictInt = Field(alias="statusCode")
+    causes: List[StrictStr]
+    __properties: ClassVar[List[str]] = ["message", "statusCode", "causes"]
+
+    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 ErrorReport 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 ErrorReport from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "message": obj.get("message"),
+            "statusCode": obj.get("statusCode"),
+            "causes": obj.get("causes")
+        })
+        return _obj
+
+

teaspoons_client/models/get_jobs_response.py

@@ -0,0 +1,99 @@
+# 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, Optional
+from teaspoons_client.models.job_report import JobReport
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetJobsResponse(BaseModel):
+    """
+    result of a getJobs request
+    """ # noqa: E501
+    total_results: Optional[StrictInt] = Field(default=None, alias="totalResults")
+    page_token: Optional[StrictStr] = Field(default=None, alias="pageToken")
+    results: Optional[List[JobReport]] = Field(default=None, description="List of retrieved jobs")
+    __properties: ClassVar[List[str]] = ["totalResults", "pageToken", "results"]
+
+    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 GetJobsResponse 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 results (list)
+        _items = []
+        if self.results:
+            for _item_results in self.results:
+                if _item_results:
+                    _items.append(_item_results.to_dict())
+            _dict['results'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetJobsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "totalResults": obj.get("totalResults"),
+            "pageToken": obj.get("pageToken"),
+            "results": [JobReport.from_dict(_item) for _item in obj["results"]] if obj.get("results") is not None else None
+        })
+        return _obj
+
+

teaspoons_client/models/get_pipeline_details_request_body.py

@@ -0,0 +1,87 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetPipelineDetailsRequestBody(BaseModel):
+    """
+    Object containing the user-provided information defining a pipeline details request 
+    """ # noqa: E501
+    pipeline_version: Optional[StrictInt] = Field(default=None, description="An identifier Integer for the Pipeline Version. ", alias="pipelineVersion")
+    __properties: ClassVar[List[str]] = ["pipelineVersion"]
+
+    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 GetPipelineDetailsRequestBody 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 GetPipelineDetailsRequestBody from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "pipelineVersion": obj.get("pipelineVersion")
+        })
+        return _obj
+
+