Skip to content

Workflow Step Dto

immichpy.client.generated.models.workflow_step_dto.WorkflowStepDto pydantic-model

Bases: BaseModel

WorkflowStepDto

Show JSON schema: 
{
  "description": "WorkflowStepDto",
  "properties": {
    "config": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "description": "Step configuration",
      "title": "Config"
    },
    "enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Step is enabled",
      "title": "Enabled"
    },
    "method": {
      "description": "Step plugin method",
      "title": "Method",
      "type": "string"
    }
  },
  "required": [
    "config",
    "method"
  ],
  "title": "WorkflowStepDto",
  "type": "object"
}

Config:

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

Fields:

config pydantic-field 

config: Optional[Dict[str, Any]]

Step configuration

enabled pydantic-field 

enabled: Optional[StrictBool] = None

Step is enabled

method pydantic-field 

method: StrictStr

Step plugin method

from_dict classmethod 

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

Create an instance of WorkflowStepDto from a dict

Source code in immichpy/client/generated/models/workflow_step_dto.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of WorkflowStepDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "config": obj.get("config"),
            "enabled": obj.get("enabled"),
            "method": obj.get("method"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of WorkflowStepDto from a JSON string

Source code in immichpy/client/generated/models/workflow_step_dto.py 
51
52
53
54
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of WorkflowStepDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

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_step_dto.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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,
    )
    # set to None if config (nullable) is None
    # and model_fields_set contains the field
    if self.config is None and "config" in self.model_fields_set:
        _dict["config"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/workflow_step_dto.py 
47
48
49
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_step_dto.py 
43
44
45
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))