Skip to content

Server Storage Response Dto

immichpy.client.generated.models.server_storage_response_dto.ServerStorageResponseDto pydantic-model

Bases: BaseModel

ServerStorageResponseDto

Show JSON schema: 
{
  "description": "ServerStorageResponseDto",
  "properties": {
    "diskAvailable": {
      "description": "Available disk space (human-readable format)",
      "title": "Diskavailable",
      "type": "string"
    },
    "diskAvailableRaw": {
      "description": "Available disk space in bytes",
      "title": "Diskavailableraw",
      "type": "integer"
    },
    "diskSize": {
      "description": "Total disk size (human-readable format)",
      "title": "Disksize",
      "type": "string"
    },
    "diskSizeRaw": {
      "description": "Total disk size in bytes",
      "title": "Disksizeraw",
      "type": "integer"
    },
    "diskUsagePercentage": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "integer"
        }
      ],
      "description": "Disk usage percentage (0-100)",
      "title": "Diskusagepercentage"
    },
    "diskUse": {
      "description": "Used disk space (human-readable format)",
      "title": "Diskuse",
      "type": "string"
    },
    "diskUseRaw": {
      "description": "Used disk space in bytes",
      "title": "Diskuseraw",
      "type": "integer"
    }
  },
  "required": [
    "diskAvailable",
    "diskAvailableRaw",
    "diskSize",
    "diskSizeRaw",
    "diskUsagePercentage",
    "diskUse",
    "diskUseRaw"
  ],
  "title": "ServerStorageResponseDto",
  "type": "object"
}

Config:

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

Fields:

disk_available pydantic-field 

disk_available: StrictStr

Available disk space (human-readable format)

disk_available_raw pydantic-field 

disk_available_raw: StrictInt

Available disk space in bytes

disk_size pydantic-field 

disk_size: StrictStr

Total disk size (human-readable format)

disk_size_raw pydantic-field 

disk_size_raw: StrictInt

Total disk size in bytes

disk_usage_percentage pydantic-field 

disk_usage_percentage: Union[StrictFloat, StrictInt]

Disk usage percentage (0-100)

disk_use pydantic-field 

disk_use: StrictStr

Used disk space (human-readable format)

disk_use_raw pydantic-field 

disk_use_raw: StrictInt

Used disk space in bytes

from_dict classmethod 

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

Create an instance of ServerStorageResponseDto from a dict

Source code in immichpy/client/generated/models/server_storage_response_dto.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of ServerStorageResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "diskAvailable": obj.get("diskAvailable"),
            "diskAvailableRaw": obj.get("diskAvailableRaw"),
            "diskSize": obj.get("diskSize"),
            "diskSizeRaw": obj.get("diskSizeRaw"),
            "diskUsagePercentage": obj.get("diskUsagePercentage"),
            "diskUse": obj.get("diskUse"),
            "diskUseRaw": obj.get("diskUseRaw"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of ServerStorageResponseDto from a JSON string

Source code in immichpy/client/generated/models/server_storage_response_dto.py 
77
78
79
80
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of ServerStorageResponseDto 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/server_storage_response_dto.py 
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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/server_storage_response_dto.py 
72
73
74
75
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/server_storage_response_dto.py 
68
69
70
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))