Skip to content

Maintenance Detect Install Response Dto

immichpy.client.generated.models.maintenance_detect_install_response_dto.MaintenanceDetectInstallResponseDto pydantic-model

Bases: BaseModel

MaintenanceDetectInstallResponseDto

Show JSON schema: 
{
  "$defs": {
    "MaintenanceDetectInstallStorageFolderDto": {
      "description": "MaintenanceDetectInstallStorageFolderDto",
      "properties": {
        "files": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "integer"
            }
          ],
          "description": "Number of files in the folder",
          "title": "Files"
        },
        "folder": {
          "$ref": "#/$defs/StorageFolder"
        },
        "readable": {
          "description": "Whether the folder is readable",
          "title": "Readable",
          "type": "boolean"
        },
        "writable": {
          "description": "Whether the folder is writable",
          "title": "Writable",
          "type": "boolean"
        }
      },
      "required": [
        "files",
        "folder",
        "readable",
        "writable"
      ],
      "title": "MaintenanceDetectInstallStorageFolderDto",
      "type": "object"
    },
    "StorageFolder": {
      "description": "Storage folder",
      "enum": [
        "encoded-video",
        "library",
        "upload",
        "profile",
        "thumbs",
        "backups"
      ],
      "title": "StorageFolder",
      "type": "string"
    }
  },
  "description": "MaintenanceDetectInstallResponseDto",
  "properties": {
    "storage": {
      "items": {
        "$ref": "#/$defs/MaintenanceDetectInstallStorageFolderDto"
      },
      "title": "Storage",
      "type": "array"
    }
  },
  "required": [
    "storage"
  ],
  "title": "MaintenanceDetectInstallResponseDto",
  "type": "object"
}

Config:

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

Fields:

from_dict classmethod 

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

Create an instance of MaintenanceDetectInstallResponseDto from a dict

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

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

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

from_json classmethod 

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

Create an instance of MaintenanceDetectInstallResponseDto from a JSON string

Source code in immichpy/client/generated/models/maintenance_detect_install_response_dto.py 
51
52
53
54
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of MaintenanceDetectInstallResponseDto 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/maintenance_detect_install_response_dto.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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 storage (list)
    _items = []
    if self.storage:
        for _item_storage in self.storage:
            if _item_storage:
                _items.append(_item_storage.to_dict())
        _dict["storage"] = _items
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

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