Skip to content

Workflow Log Entry Dto

immichpy.client.generated.models.workflow_log_entry_dto.WorkflowLogEntryDto pydantic-model

Bases: BaseModel

WorkflowLogEntryDto

Show JSON schema: 
{
  "$defs": {
    "WorkflowLogEntryDtoLastStep": {
      "description": "Last step ran, if the workflow ended early",
      "properties": {
        "index": {
          "description": "Index of the step in the workflow",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991,
          "title": "Index",
          "type": "integer"
        },
        "method": {
          "description": "Method of the step",
          "title": "Method",
          "type": "string"
        }
      },
      "required": [
        "index",
        "method"
      ],
      "title": "WorkflowLogEntryDtoLastStep",
      "type": "object"
    },
    "WorkflowResult": {
      "description": "Workflow run result",
      "enum": [
        "completed",
        "halted",
        "error"
      ],
      "title": "WorkflowResult",
      "type": "string"
    }
  },
  "description": "WorkflowLogEntryDto",
  "properties": {
    "at": {
      "description": "Workflow run date/time",
      "examples": [
        "2024-01-01T00:00:00Z"
      ],
      "format": "date-time",
      "title": "At",
      "type": "string"
    },
    "id": {
      "description": "Workflow log entry ID",
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "lastStep": {
      "anyOf": [
        {
          "$ref": "#/$defs/WorkflowLogEntryDtoLastStep"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "result": {
      "$ref": "#/$defs/WorkflowResult"
    },
    "triggerDataId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Workflow trigger data ID",
      "title": "Triggerdataid"
    }
  },
  "required": [
    "at",
    "id",
    "result"
  ],
  "title": "WorkflowLogEntryDto",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

Validators:

at pydantic-field 

at: datetime

Workflow run date/time

id pydantic-field 

id: UUID

Workflow log entry ID

trigger_data_id pydantic-field 

trigger_data_id: Optional[UUID] = None

Workflow trigger data ID

at_validate_regular_expression pydantic-validator 

at_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/workflow_log_entry_dto.py 
57
58
59
60
61
62
63
64
65
66
67
@field_validator("at", mode="before")
def at_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/"
        )
    return value

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of WorkflowLogEntryDto from a dict

Source code in immichpy/client/generated/models/workflow_log_entry_dto.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of WorkflowLogEntryDto from a dict"""
    if obj is None:
        return None

    if not isinstance(obj, dict):
        return cls.model_validate(obj)

    _obj = cls.model_validate(
        {
            "at": obj.get("at"),
            "id": obj.get("id"),
            "lastStep": WorkflowLogEntryDtoLastStep.from_dict(obj["lastStep"])
            if obj.get("lastStep") is not None
            else None,
            "result": obj.get("result"),
            "triggerDataId": obj.get("triggerDataId"),
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of WorkflowLogEntryDto from a JSON string

Source code in immichpy/client/generated/models/workflow_log_entry_dto.py 
111
112
113
114
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of WorkflowLogEntryDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

id_validate_regular_expression pydantic-validator 

id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/workflow_log_entry_dto.py 
69
70
71
72
73
74
75
76
77
78
79
@field_validator("id", mode="before")
def id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    return value

to_dict 

to_dict() -> 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.
Source code in immichpy/client/generated/models/workflow_log_entry_dto.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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 last_step
    if self.last_step:
        _dict["lastStep"] = self.last_step.to_dict()
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/workflow_log_entry_dto.py 
107
108
109
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    return json.dumps(to_jsonable_python(self.to_dict()))

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/workflow_log_entry_dto.py 
103
104
105
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))

trigger_data_id_validate_regular_expression pydantic-validator 

trigger_data_id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/workflow_log_entry_dto.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
@field_validator("trigger_data_id", mode="before")
def trigger_data_id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if value is None:
        return value

    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/"
        )
    return value