Tag Create Dto
immichpy.client.generated.models.tag_create_dto.TagCreateDto
pydantic-model
Bases: BaseModel
TagCreateDto
Show JSON schema:
{
"description": "TagCreateDto",
"properties": {
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Tag color (hex)",
"title": "Color"
},
"name": {
"description": "Tag name",
"title": "Name",
"type": "string"
},
"parentId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Parent tag ID",
"title": "Parentid"
}
},
"required": [
"name"
],
"title": "TagCreateDto",
"type": "object"
}
Config:
validate_by_name:Truevalidate_by_alias:Truevalidate_assignment:Trueprotected_namespaces:()
Fields:
-
color(Optional[Annotated[str, Field(strict=True)]]) -
name(Annotated[str, Field(strict=True)]) -
parent_id(Optional[UUID])
Validators:
-
color_validate_regular_expression→color -
name_validate_regular_expression→name -
parent_id_validate_regular_expression→parent_id
color
pydantic-field
color: Optional[Annotated[str, Field(strict=True)]] = None
Tag color (hex)
name
pydantic-field
name: Annotated[str, Field(strict=True)]
Tag name
parent_id
pydantic-field
parent_id: Optional[UUID] = None
Parent tag ID
color_validate_regular_expression
pydantic-validator
color_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/tag_create_dto.py
42 43 44 45 46 47 48 49 50 51 52 53 54 | |
from_dict
classmethod
from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of TagCreateDto from a dict
Source code in immichpy/client/generated/models/tag_create_dto.py
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | |
from_json
classmethod
from_json(json_str: str) -> Optional[Self]
Create an instance of TagCreateDto from a JSON string
Source code in immichpy/client/generated/models/tag_create_dto.py
93 94 95 96 | |
name_validate_regular_expression
pydantic-validator
name_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/tag_create_dto.py
56 57 58 59 60 61 | |
parent_id_validate_regular_expression
pydantic-validator
parent_id_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/tag_create_dto.py
63 64 65 66 67 68 69 70 71 72 73 74 75 76 | |
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/tag_create_dto.py
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 | |
to_json
to_json() -> str
Returns the JSON representation of the model using alias
Source code in immichpy/client/generated/models/tag_create_dto.py
89 90 91 | |
to_str
to_str() -> str
Returns the string representation of the model using alias
Source code in immichpy/client/generated/models/tag_create_dto.py
85 86 87 | |