Skip to content

Workflow Action Response Dto

immichpy.client.generated.models.workflow_action_response_dto.WorkflowActionResponseDto pydantic-model

Bases: BaseModel

WorkflowActionResponseDto

Show JSON schema: 
{
  "description": "WorkflowActionResponseDto",
  "properties": {
    "actionConfig": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "description": "Action configuration",
      "title": "Actionconfig"
    },
    "id": {
      "description": "Action ID",
      "title": "Id",
      "type": "string"
    },
    "order": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "integer"
        }
      ],
      "description": "Action order",
      "title": "Order"
    },
    "pluginActionId": {
      "description": "Plugin action ID",
      "title": "Pluginactionid",
      "type": "string"
    },
    "workflowId": {
      "description": "Workflow ID",
      "title": "Workflowid",
      "type": "string"
    }
  },
  "required": [
    "actionConfig",
    "id",
    "order",
    "pluginActionId",
    "workflowId"
  ],
  "title": "WorkflowActionResponseDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

action_config pydantic-field 

action_config: Optional[Dict[str, Any]]

Action configuration

id pydantic-field 

id: StrictStr

Action ID

order pydantic-field 

order: Union[StrictFloat, StrictInt]

Action order

plugin_action_id pydantic-field 

plugin_action_id: StrictStr

Plugin action ID

workflow_id pydantic-field 

workflow_id: StrictStr

Workflow ID

from_dict classmethod 

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

Create an instance of WorkflowActionResponseDto from a dict

Source code in immichpy/client/generated/models/workflow_action_response_dto.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of WorkflowActionResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "actionConfig": obj.get("actionConfig"),
            "id": obj.get("id"),
            "order": obj.get("order"),
            "pluginActionId": obj.get("pluginActionId"),
            "workflowId": obj.get("workflowId"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of WorkflowActionResponseDto from a JSON string

Source code in immichpy/client/generated/models/workflow_action_response_dto.py 
62
63
64
65
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of WorkflowActionResponseDto 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_action_response_dto.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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 action_config (nullable) is None
    # and model_fields_set contains the field
    if self.action_config is None and "action_config" in self.model_fields_set:
        _dict["actionConfig"] = 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_action_response_dto.py 
57
58
59
60
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())

to_str 

to_str() -> str

Returns the string representation of the model using alias

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