Skip to content

Maintenance Detect Install Storage Folder Dto

immichpy.client.generated.models.maintenance_detect_install_storage_folder_dto.MaintenanceDetectInstallStorageFolderDto pydantic-model

Bases: BaseModel

MaintenanceDetectInstallStorageFolderDto

Show JSON schema: 
{
  "$defs": {
    "StorageFolder": {
      "description": "Storage folder",
      "enum": [
        "encoded-video",
        "library",
        "upload",
        "profile",
        "thumbs",
        "backups"
      ],
      "title": "StorageFolder",
      "type": "string"
    }
  },
  "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"
}

Config:

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

Fields:

files pydantic-field 

files: Union[StrictFloat, StrictInt]

Number of files in the folder

folder pydantic-field 

folder: StorageFolder

Storage folder

readable pydantic-field 

readable: StrictBool

Whether the folder is readable

writable pydantic-field 

writable: StrictBool

Whether the folder is writable

from_dict classmethod 

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

Create an instance of MaintenanceDetectInstallStorageFolderDto from a dict

Source code in immichpy/client/generated/models/maintenance_detect_install_storage_folder_dto.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of MaintenanceDetectInstallStorageFolderDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "files": obj.get("files"),
            "folder": obj.get("folder"),
            "readable": obj.get("readable"),
            "writable": obj.get("writable"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of MaintenanceDetectInstallStorageFolderDto from a JSON string

Source code in immichpy/client/generated/models/maintenance_detect_install_storage_folder_dto.py 
54
55
56
57
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of MaintenanceDetectInstallStorageFolderDto 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_storage_folder_dto.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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,
    )
    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_storage_folder_dto.py 
49
50
51
52
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_storage_folder_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))