mirror of
https://github.com/hatchet-dev/hatchet.git
synced 2026-01-06 08:49:53 -06:00
d376b953aa
* feat: Adds a generated REST API client and exposes workflow methods for programmatic usage
106 lines
3.4 KiB
Python
106 lines
3.4 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
Hatchet API
|
|
|
|
The Hatchet API
|
|
|
|
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, Field, StrictStr
|
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
from hatchet_sdk.clients.rest.models.api_resource_meta import APIResourceMeta
|
|
from typing import Optional, Set
|
|
from typing_extensions import Self
|
|
|
|
class Step(BaseModel):
|
|
"""
|
|
Step
|
|
""" # noqa: E501
|
|
metadata: APIResourceMeta
|
|
readable_id: StrictStr = Field(description="The readable id of the step.", alias="readableId")
|
|
tenant_id: StrictStr = Field(alias="tenantId")
|
|
job_id: StrictStr = Field(alias="jobId")
|
|
action: StrictStr
|
|
timeout: Optional[StrictStr] = Field(default=None, description="The timeout of the step.")
|
|
children: Optional[List[StrictStr]] = None
|
|
parents: Optional[List[StrictStr]] = None
|
|
__properties: ClassVar[List[str]] = ["metadata", "readableId", "tenantId", "jobId", "action", "timeout", "children", "parents"]
|
|
|
|
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 Step 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 metadata
|
|
if self.metadata:
|
|
_dict['metadata'] = self.metadata.to_dict()
|
|
return _dict
|
|
|
|
@classmethod
|
|
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
"""Create an instance of Step from a dict"""
|
|
if obj is None:
|
|
return None
|
|
|
|
if not isinstance(obj, dict):
|
|
return cls.model_validate(obj)
|
|
|
|
_obj = cls.model_validate({
|
|
"metadata": APIResourceMeta.from_dict(obj["metadata"]) if obj.get("metadata") is not None else None,
|
|
"readableId": obj.get("readableId"),
|
|
"tenantId": obj.get("tenantId"),
|
|
"jobId": obj.get("jobId"),
|
|
"action": obj.get("action"),
|
|
"timeout": obj.get("timeout"),
|
|
"children": obj.get("children"),
|
|
"parents": obj.get("parents")
|
|
})
|
|
return _obj
|
|
|
|
|