Skip to content

Asset Face Update Dto

immichpy.client.generated.models.asset_face_update_dto.AssetFaceUpdateDto pydantic-model

Bases: BaseModel

AssetFaceUpdateDto

Show JSON schema:
{
  "$defs": {
    "AssetFaceUpdateItem": {
      "description": "AssetFaceUpdateItem",
      "properties": {
        "assetId": {
          "description": "Asset ID",
          "format": "uuid",
          "title": "Assetid",
          "type": "string"
        },
        "personId": {
          "description": "Person ID",
          "format": "uuid",
          "title": "Personid",
          "type": "string"
        }
      },
      "required": [
        "assetId",
        "personId"
      ],
      "title": "AssetFaceUpdateItem",
      "type": "object"
    }
  },
  "description": "AssetFaceUpdateDto",
  "properties": {
    "data": {
      "description": "Face update items",
      "items": {
        "$ref": "#/$defs/AssetFaceUpdateItem"
      },
      "title": "Data",
      "type": "array"
    }
  },
  "required": [
    "data"
  ],
  "title": "AssetFaceUpdateDto",
  "type": "object"
}

Config:

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

Fields:

data pydantic-field

data: List[AssetFaceUpdateItem]

Face update items

from_dict classmethod

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

Create an instance of AssetFaceUpdateDto from a dict

Source code in immichpy/client/generated/models/asset_face_update_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 AssetFaceUpdateDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "data": [AssetFaceUpdateItem.from_dict(_item) for _item in obj["data"]]
            if obj.get("data") is not None
            else None
        }
    )
    return _obj

from_json classmethod

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

Create an instance of AssetFaceUpdateDto from a JSON string

Source code in immichpy/client/generated/models/asset_face_update_dto.py
49
50
51
52
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of AssetFaceUpdateDto 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/asset_face_update_dto.py
54
55
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,
    )
    # override the default output from pydantic by calling `to_dict()` of each item in data (list)
    _items = []
    if self.data:
        for _item_data in self.data:
            if _item_data:
                _items.append(_item_data.to_dict())
        _dict["data"] = _items
    return _dict

to_json

to_json() -> str

Returns the JSON representation of the model using alias

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