Skip to content

Integrity Report Response Dto

immichpy.client.generated.models.integrity_report_response_dto.IntegrityReportResponseDto pydantic-model

Bases: BaseModel

IntegrityReportResponseDto

Show JSON schema: 
{
  "$defs": {
    "IntegrityReport": {
      "description": "Integrity report type",
      "enum": [
        "untracked_file",
        "missing_file",
        "checksum_mismatch"
      ],
      "title": "IntegrityReport",
      "type": "string"
    },
    "IntegrityReportResponseDtoItemsInner": {
      "description": "IntegrityReportResponseDtoItemsInner",
      "properties": {
        "id": {
          "description": "Integrity report item id",
          "format": "uuid",
          "title": "Id",
          "type": "string"
        },
        "path": {
          "description": "Integrity report item path",
          "title": "Path",
          "type": "string"
        },
        "type": {
          "$ref": "#/$defs/IntegrityReport"
        }
      },
      "required": [
        "id",
        "path",
        "type"
      ],
      "title": "IntegrityReportResponseDtoItemsInner",
      "type": "object"
    }
  },
  "description": "IntegrityReportResponseDto",
  "properties": {
    "items": {
      "items": {
        "$ref": "#/$defs/IntegrityReportResponseDtoItemsInner"
      },
      "title": "Items",
      "type": "array"
    },
    "nextCursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Nextcursor"
    }
  },
  "required": [
    "items"
  ],
  "title": "IntegrityReportResponseDto",
  "type": "object"
}

Config:

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

Fields:

from_dict classmethod 

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

Create an instance of IntegrityReportResponseDto from a dict

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

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

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

from_json classmethod 

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

Create an instance of IntegrityReportResponseDto from a JSON string

Source code in immichpy/client/generated/models/integrity_report_response_dto.py 
53
54
55
56
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of IntegrityReportResponseDto 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/integrity_report_response_dto.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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 items (list)
    _items = []
    if self.items:
        for _item_items in self.items:
            _items.append(
                _item_items.to_dict() if _item_items is not None else None
            )
        _dict["items"] = _items
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

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