Workflow Response Dto
immichpy.client.generated.models.workflow_response_dto.WorkflowResponseDto
pydantic-model
Bases: BaseModel
WorkflowResponseDto
Show JSON schema:
{
"$defs": {
"WorkflowStepDto": {
"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"
},
"WorkflowTrigger": {
"description": "Plugin trigger type",
"enum": [
"AssetCreate",
"AssetMetadataExtraction",
"AssetTagged"
],
"title": "WorkflowTrigger",
"type": "string"
}
},
"description": "WorkflowResponseDto",
"properties": {
"createdAt": {
"description": "Creation date",
"title": "Createdat",
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Workflow description",
"title": "Description"
},
"enabled": {
"description": "Workflow enabled",
"title": "Enabled",
"type": "boolean"
},
"id": {
"description": "Workflow ID",
"format": "uuid",
"title": "Id",
"type": "string"
},
"logging": {
"description": "Workflow logs run results",
"title": "Logging",
"type": "boolean"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Workflow name",
"title": "Name"
},
"steps": {
"description": "Workflow steps",
"items": {
"$ref": "#/$defs/WorkflowStepDto"
},
"title": "Steps",
"type": "array"
},
"trigger": {
"$ref": "#/$defs/WorkflowTrigger"
},
"updatedAt": {
"description": "Update date",
"title": "Updatedat",
"type": "string"
}
},
"required": [
"createdAt",
"description",
"enabled",
"id",
"logging",
"name",
"steps",
"trigger",
"updatedAt"
],
"title": "WorkflowResponseDto",
"type": "object"
}
Config:
validate_by_name:Truevalidate_by_alias:Truevalidate_assignment:Trueprotected_namespaces:()
Fields:
-
created_at(StrictStr) -
description(Optional[StrictStr]) -
enabled(StrictBool) -
id(UUID) -
logging(StrictBool) -
name(Optional[StrictStr]) -
steps(List[WorkflowStepDto]) -
trigger(WorkflowTrigger) -
updated_at(StrictStr)
Validators:
created_at
pydantic-field
created_at: StrictStr
Creation date
description
pydantic-field
description: Optional[StrictStr]
Workflow description
enabled
pydantic-field
enabled: StrictBool
Workflow enabled
id
pydantic-field
id: UUID
Workflow ID
logging
pydantic-field
logging: StrictBool
Workflow logs run results
name
pydantic-field
name: Optional[StrictStr]
Workflow name
steps
pydantic-field
steps: List[WorkflowStepDto]
Workflow steps
updated_at
pydantic-field
updated_at: StrictStr
Update date
from_dict
classmethod
from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of WorkflowResponseDto from a dict
Source code in immichpy/client/generated/models/workflow_response_dto.py
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | |
from_json
classmethod
from_json(json_str: str) -> Optional[Self]
Create an instance of WorkflowResponseDto from a JSON string
Source code in immichpy/client/generated/models/workflow_response_dto.py
89 90 91 92 | |
id_validate_regular_expression
pydantic-validator
id_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/workflow_response_dto.py
62 63 64 65 66 67 68 69 70 71 72 | |
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):
Noneis only added to the output dict for nullable fields that were set at model initialization. Other fields with valueNoneare ignored.
Source code in immichpy/client/generated/models/workflow_response_dto.py
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | |
to_json
to_json() -> str
Returns the JSON representation of the model using alias
Source code in immichpy/client/generated/models/workflow_response_dto.py
85 86 87 | |
to_str
to_str() -> str
Returns the string representation of the model using alias
Source code in immichpy/client/generated/models/workflow_response_dto.py
81 82 83 | |